A Discrete-Event Network Simulator
API
ns3::Hash::Function::Hash32 Class Reference

Template for creating a Hash::Implementation from a 32-bit hash function. More...

#include "hash-function.h"

+ Inheritance diagram for ns3::Hash::Function::Hash32:
+ Collaboration diagram for ns3::Hash::Function::Hash32:

Public Member Functions

 Hash32 (Hash32Function_ptr hp)
 Constructor from a 32-bit hash function pointer. More...
 
void clear ()
 Restore initial state. More...
 
uint32_t GetHash32 (const char *buffer, const std::size_t size)
 Compute 32-bit hash of a byte buffer. More...
 
- Public Member Functions inherited from ns3::Hash::Implementation
 Implementation ()
 Constructor. More...
 
virtual ~Implementation ()
 Destructor. More...
 
virtual uint64_t GetHash64 (const char *buffer, const std::size_t size)
 Compute 64-bit hash of a byte buffer. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Implementation >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Hash32Function_ptr m_fp
 The hash function. More...
 

Detailed Description

Template for creating a Hash::Implementation from a 32-bit hash function.

Definition at line 129 of file hash-function.h.

Constructor & Destructor Documentation

◆ Hash32()

ns3::Hash::Function::Hash32::Hash32 ( Hash32Function_ptr  hp)
inline

Constructor from a 32-bit hash function pointer.

Parameters
[in]hpFunction pointer to a 32-bit hash function.

Definition at line 137 of file hash-function.h.

Member Function Documentation

◆ clear()

void ns3::Hash::Function::Hash32::clear ( )
inlinevirtual

Restore initial state.

Implements ns3::Hash::Implementation.

Definition at line 143 of file hash-function.h.

◆ GetHash32()

uint32_t ns3::Hash::Function::Hash32::GetHash32 ( const char *  buffer,
const std::size_t  size 
)
inlinevirtual

Compute 32-bit hash of a byte buffer.

Call clear() between calls to GetHash32() to reset the internal state and hash each buffer separately.

If you don't call clear() between calls to GetHash32, you can hash successive buffers. The final return value will be the cumulative hash across all calls.

Parameters
[in]bufferPointer to the beginning of the buffer.
[in]sizeLength of the buffer, in bytes.
Returns
32-bit hash of the buffer.

Implements ns3::Hash::Implementation.

Definition at line 139 of file hash-function.h.

References m_fp.

Member Data Documentation

◆ m_fp

Hash32Function_ptr ns3::Hash::Function::Hash32::m_fp
private

The hash function.

Definition at line 147 of file hash-function.h.

Referenced by GetHash32().


The documentation for this class was generated from the following file: