A Discrete-Event Network Simulator
API
ns3::QKDInternalTag Class Reference

Introspection did not find any typical Config paths. More...

#include "qkd-internal-tag.h"

+ Inheritance diagram for ns3::QKDInternalTag:
+ Collaboration diagram for ns3::QKDInternalTag:

Public Member Functions

virtual void Deserialize (TagBuffer i)
 
uint8_t GetAuthenticateValue (void) const
 
uint8_t GetEncryptValue (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint32_t GetMaxDelayValue (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetAuthenticateValue (uint8_t value)
 
void SetEncryptValue (uint8_t value)
 
void SetMaxDelayValue (uint32_t value)
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the TypeId. More...
 
- Static Public Member Functions inherited from ns3::Tag
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_authenticateValue
 Type of authentication scheme to be used. More...
 
uint8_t m_encryptValue
 Type of encryption scheme to be used. More...
 
uint32_t m_maxDelay
 maximal tolerated delay More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Introspection did not find any typical Config paths.

QKDInternalTag is used to carry information from the application layer (L5) about the encryption and authentication scheme that should be used on L2 when encrypting and authenticating the packet.


Attributes

  • Encrypt: Should Enrypt
  • Authenticate: Should Authenticate

No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

QKDInternalTag carries info about the desired authentication and encryption mechanism to be used in QKDCrypto on L2 when performing cryptographic operations. Also, it carries details about the maximal tolerated delay in QKD network. The function of MaxDelay field is similar to the Time-to-Live (TTL) field in the IP header of conventional networks, but with the aim of minimizing the consumption of scarce key material in QKD network.

Definition at line 127 of file qkd-internal-tag.h.

Member Function Documentation

void ns3::QKDInternalTag::Deserialize ( TagBuffer  i)
virtual
Parameters
ithe buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

Definition at line 203 of file qkd-internal-tag.cc.

References ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().

+ Here is the call graph for this function:

uint8_t ns3::QKDInternalTag::GetAuthenticateValue ( void  ) const
uint8_t ns3::QKDInternalTag::GetEncryptValue ( void  ) const
TypeId ns3::QKDInternalTag::GetInstanceTypeId ( void  ) const
virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 186 of file qkd-internal-tag.cc.

References ns3::QKDCommandTag::GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::QKDInternalTag::GetMaxDelayValue ( void  ) const

Definition at line 247 of file qkd-internal-tag.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::QKDManager::ProcessOutgoingRequest().

+ Here is the caller graph for this function:

uint32_t ns3::QKDInternalTag::GetSerializedSize ( void  ) const
virtual
Returns
the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 191 of file qkd-internal-tag.cc.

TypeId ns3::QKDInternalTag::GetTypeId ( void  )
static

Get the TypeId.

Returns
The TypeId for this class

Definition at line 167 of file qkd-internal-tag.cc.

References GetAuthenticateValue(), GetEncryptValue(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::QKDInternalTag::Print ( std::ostream &  os) const
virtual
Parameters
osthe stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 210 of file qkd-internal-tag.cc.

References NS_LOG_FUNCTION.

void ns3::QKDInternalTag::Serialize ( TagBuffer  i) const
virtual
Parameters
ithe buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

Definition at line 196 of file qkd-internal-tag.cc.

References ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().

+ Here is the call graph for this function:

void ns3::QKDInternalTag::SetAuthenticateValue ( uint8_t  value)

Definition at line 216 of file qkd-internal-tag.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::QKDCrypto::Decrypt(), and ns3::QKDManager::ProcessOutgoingRequest().

+ Here is the caller graph for this function:

void ns3::QKDInternalTag::SetEncryptValue ( uint8_t  value)

Definition at line 228 of file qkd-internal-tag.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::QKDManager::ProcessOutgoingRequest().

+ Here is the caller graph for this function:

void ns3::QKDInternalTag::SetMaxDelayValue ( uint32_t  value)

Definition at line 241 of file qkd-internal-tag.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::QKDManager::ProcessOutgoingRequest().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::QKDInternalTag::m_authenticateValue
private

Type of authentication scheme to be used.

Definition at line 153 of file qkd-internal-tag.h.

uint8_t ns3::QKDInternalTag::m_encryptValue
private

Type of encryption scheme to be used.

Definition at line 152 of file qkd-internal-tag.h.

uint32_t ns3::QKDInternalTag::m_maxDelay
private

maximal tolerated delay

Definition at line 154 of file qkd-internal-tag.h.


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