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

#include "qkd-application-entry.h"

+ Inheritance diagram for ns3::QKDApplicationEntry:
+ Collaboration diagram for ns3::QKDApplicationEntry:

Public Types

enum  ConnectionType {
  NONE = 0 , ETSI_QKD_014_ENCRYPTION = 1 , ETSI_QKD_014_AUTHENTICATION = 2 , ETSI_QKD_004_ENCRYPTION = 3 ,
  ETSI_QKD_004_AUTHENTICATION = 4
}
 The connection types. More...
 

Public Member Functions

 QKDApplicationEntry ()
 Empty constructor. More...
 
 QKDApplicationEntry (UUID keyAssociationId, UUID srcSaeId, UUID dstSaeId, ConnectionType type, uint32_t priority, double expirationTime, Ipv4Address srcKMSAddress, Ipv4Address dstKMSAddress)
 Constructor. More...
 
 ~QKDApplicationEntry ()
 Destructor. More...
 
Ipv4Address GetDestinationKmsAddress () const
 Get the destination KMS IP address. More...
 
UUID GetDestinationSaeId ()
 Get the destination (receiver) application identifier. More...
 
UUID GetId ()
 Get the application identifier. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the type ID for the instance. More...
 
UUID GetKeyAssociationId ()
 Get the association identifier. More...
 
Ipv4Address GetSourceKmsAddress () const
 \briet Get the source KMS IP address. More...
 
UUID GetSrcSaeId ()
 Get the source (sender) application identifier. More...
 
QKDApplicationEntry::ConnectionType GetType ()
 Get the connection type. More...
 
bool IsValid ()
 Check if entry is valid. More...
 
void Print (Ptr< OutputStreamWrapper > stream) const
 Print the routing table entry. More...
 
void PrintRegistryInfo ()
 Print the registry information. More...
 
void SetId (UUID value)
 Set the application identifier. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- 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 errors. 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 type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Public Attributes

UUID m_app_id
 
uint32_t m_app_priority
 
uint32_t m_app_statistics_statistic_consumed_bits
 
QKDApplicationEntry::ConnectionType m_app_type
 
UUID m_backing_qkdl_id
 
UUID m_client_app_id
 
bool m_clients_shared_keys_required
 
double m_creation_time
 
double m_expiration_time
 
Ipv4Address m_kmsDstAddress
 
Ipv4Address m_kmsSrcAddress
 
uint32_t m_local_qkdn_id
 
bool m_qos_clients_shared_path_enable
 
double m_qos_jitter
 
double m_qos_max_bandwidth
 
double m_qos_min_bandwidth
 
double m_qos_ttl
 
uint32_t m_remote_qkdn_id
 
UUID m_server_app_id
 
bool m_valid
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Definition at line 77 of file qkd-application-entry.h.

Member Enumeration Documentation

◆ ConnectionType

The connection types.

Enumerator
NONE 
ETSI_QKD_014_ENCRYPTION 
ETSI_QKD_014_AUTHENTICATION 
ETSI_QKD_004_ENCRYPTION 
ETSI_QKD_004_AUTHENTICATION 

Definition at line 84 of file qkd-application-entry.h.

Constructor & Destructor Documentation

◆ QKDApplicationEntry() [1/2]

ns3::QKDApplicationEntry::QKDApplicationEntry ( )

Empty constructor.

Definition at line 57 of file qkd-application-entry.cc.

References m_valid.

◆ QKDApplicationEntry() [2/2]

ns3::QKDApplicationEntry::QKDApplicationEntry ( UUID  keyAssociationId,
UUID  srcSaeId,
UUID  dstSaeId,
ConnectionType  type,
uint32_t  priority,
double  expirationTime,
Ipv4Address  srcKMSAddress,
Ipv4Address  dstKMSAddress 
)

Constructor.

Parameters
keyAssociationIdThe key association identifier.
srcSaeIdThe source (sender) application identifier (UUID).
dstSaeIdThe destination (receiver) application identifier (UUID).
typeThe connection type.
priorityThe association priority.
expirationTimeThe association expiration time.
srcKMSAddressThe source KMS IP address.
dstKMSAddressThe destination KMS IP address.

Definition at line 61 of file qkd-application-entry.cc.

References m_app_id, m_app_priority, m_app_type, m_backing_qkdl_id, m_client_app_id, m_expiration_time, m_kmsDstAddress, m_kmsSrcAddress, m_server_app_id, m_valid, NS_LOG_FUNCTION, and ns3::UUID::Random().

+ Here is the call graph for this function:

◆ ~QKDApplicationEntry()

ns3::QKDApplicationEntry::~QKDApplicationEntry ( )

Destructor.

Definition at line 97 of file qkd-application-entry.cc.

Member Function Documentation

◆ GetDestinationKmsAddress()

Ipv4Address ns3::QKDApplicationEntry::GetDestinationKmsAddress ( ) const
inline

Get the destination KMS IP address.

Returns
The destination KMS IP address.

Definition at line 152 of file qkd-application-entry.h.

References m_kmsDstAddress.

Referenced by ns3::QKDKeyManagerSystemApplication::ProcessNewAppRequest().

+ Here is the caller graph for this function:

◆ GetDestinationSaeId()

UUID ns3::QKDApplicationEntry::GetDestinationSaeId ( )
inline

Get the destination (receiver) application identifier.

Returns
The destination application identifier (UUID).

Definition at line 179 of file qkd-application-entry.h.

References m_server_app_id.

◆ GetId()

◆ GetInstanceTypeId()

TypeId ns3::QKDApplicationEntry::GetInstanceTypeId ( void  ) const
virtual

Get the type ID for the instance.

Returns
The instance TypeId.

Reimplemented from ns3::Object.

Definition at line 52 of file qkd-application-entry.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetKeyAssociationId()

UUID ns3::QKDApplicationEntry::GetKeyAssociationId ( )
inline

Get the association identifier.

Returns
The association identifier.

Definition at line 214 of file qkd-application-entry.h.

References m_backing_qkdl_id.

Referenced by ns3::QKDControl::RegisterQKDApplications().

+ Here is the caller graph for this function:

◆ GetSourceKmsAddress()

Ipv4Address ns3::QKDApplicationEntry::GetSourceKmsAddress ( ) const
inline

\briet Get the source KMS IP address.

Returns
The source KMS IP address.

Definition at line 143 of file qkd-application-entry.h.

References m_kmsSrcAddress.

◆ GetSrcSaeId()

UUID ns3::QKDApplicationEntry::GetSrcSaeId ( )
inline

Get the source (sender) application identifier.

Returns
The source application identifier (UUID).

Definition at line 172 of file qkd-application-entry.h.

References m_client_app_id.

Referenced by ns3::QKDKeyManagerSystemApplication::ProcessTransformRequest().

+ Here is the caller graph for this function:

◆ GetType()

QKDApplicationEntry::ConnectionType ns3::QKDApplicationEntry::GetType ( )
inline

Get the connection type.

Returns
The connection type.

Definition at line 207 of file qkd-application-entry.h.

References m_app_type.

◆ GetTypeId()

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

Get the type ID.

Returns
The object TypeId.

Definition at line 41 of file qkd-application-entry.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsValid()

◆ Print()

void ns3::QKDApplicationEntry::Print ( Ptr< OutputStreamWrapper stream) const

Print the routing table entry.

Parameters
Thestream the output stream.

Definition at line 119 of file qkd-application-entry.cc.

References ns3::OutputStreamWrapper::GetStream(), m_app_id, m_app_priority, m_app_type, m_backing_qkdl_id, m_client_app_id, m_expiration_time, m_kmsDstAddress, m_kmsSrcAddress, m_server_app_id, and m_valid.

+ Here is the call graph for this function:

◆ PrintRegistryInfo()

◆ SetId()

void ns3::QKDApplicationEntry::SetId ( UUID  value)
inline

Set the application identifier.

Definition at line 192 of file qkd-application-entry.h.

References m_app_id.

Referenced by ns3::QKDKeyManagerSystemApplication::RegisterApplicationEntry().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_app_id

UUID ns3::QKDApplicationEntry::m_app_id

Definition at line 218 of file qkd-application-entry.h.

Referenced by QKDApplicationEntry(), GetId(), Print(), PrintRegistryInfo(), and SetId().

◆ m_app_priority

uint32_t ns3::QKDApplicationEntry::m_app_priority

Definition at line 231 of file qkd-application-entry.h.

Referenced by QKDApplicationEntry(), Print(), and PrintRegistryInfo().

◆ m_app_statistics_statistic_consumed_bits

uint32_t ns3::QKDApplicationEntry::m_app_statistics_statistic_consumed_bits

Definition at line 234 of file qkd-application-entry.h.

◆ m_app_type

QKDApplicationEntry::ConnectionType ns3::QKDApplicationEntry::m_app_type

Definition at line 225 of file qkd-application-entry.h.

Referenced by QKDApplicationEntry(), GetType(), Print(), and PrintRegistryInfo().

◆ m_backing_qkdl_id

UUID ns3::QKDApplicationEntry::m_backing_qkdl_id

◆ m_client_app_id

UUID ns3::QKDApplicationEntry::m_client_app_id

◆ m_clients_shared_keys_required

bool ns3::QKDApplicationEntry::m_clients_shared_keys_required

Definition at line 224 of file qkd-application-entry.h.

◆ m_creation_time

double ns3::QKDApplicationEntry::m_creation_time

Definition at line 232 of file qkd-application-entry.h.

◆ m_expiration_time

double ns3::QKDApplicationEntry::m_expiration_time

Definition at line 233 of file qkd-application-entry.h.

Referenced by QKDApplicationEntry(), Print(), and PrintRegistryInfo().

◆ m_kmsDstAddress

Ipv4Address ns3::QKDApplicationEntry::m_kmsDstAddress

◆ m_kmsSrcAddress

Ipv4Address ns3::QKDApplicationEntry::m_kmsSrcAddress

◆ m_local_qkdn_id

uint32_t ns3::QKDApplicationEntry::m_local_qkdn_id

Definition at line 229 of file qkd-application-entry.h.

◆ m_qos_clients_shared_path_enable

bool ns3::QKDApplicationEntry::m_qos_clients_shared_path_enable

Definition at line 223 of file qkd-application-entry.h.

◆ m_qos_jitter

double ns3::QKDApplicationEntry::m_qos_jitter

Definition at line 221 of file qkd-application-entry.h.

◆ m_qos_max_bandwidth

double ns3::QKDApplicationEntry::m_qos_max_bandwidth

Definition at line 219 of file qkd-application-entry.h.

◆ m_qos_min_bandwidth

double ns3::QKDApplicationEntry::m_qos_min_bandwidth

Definition at line 220 of file qkd-application-entry.h.

◆ m_qos_ttl

double ns3::QKDApplicationEntry::m_qos_ttl

Definition at line 222 of file qkd-application-entry.h.

◆ m_remote_qkdn_id

uint32_t ns3::QKDApplicationEntry::m_remote_qkdn_id

Definition at line 230 of file qkd-application-entry.h.

◆ m_server_app_id

UUID ns3::QKDApplicationEntry::m_server_app_id

◆ m_valid

bool ns3::QKDApplicationEntry::m_valid

Definition at line 235 of file qkd-application-entry.h.

Referenced by QKDApplicationEntry(), IsValid(), Print(), and PrintRegistryInfo().


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