key stream session More...

#include "app-key-stream.h"

Inheritance diagram for ns3::KeyStreamSession:

Collaboration diagram for ns3::KeyStreamSession:

Public Types
enum	Type { EMPTY , ENCRYPTION , AUTHENTICATION }

Public Member Functions
	KeyStreamSession ()

void	AddKey (Ptr< AppKey > key)

void	ClearStream ()

std::string	GetId () const

Ptr< AppKey >	GetKey (uint32_t packetSize=0)

uint32_t	GetKeyCount () const

uint32_t	GetSize () const

Type	GetType () const

bool	IsVerified () const

void	SetId (std::string ksid)

void	SetSize (uint32_t size)

void	SetType (Type type)

void	SetVerified (bool isVerified)

bool	SyncStream (uint32_t index)

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Private Attributes
std::string	m_id

uint32_t	m_size

std::map< uint32_t, Ptr< AppKey > >	m_stream

Type	m_type

bool	m_verified

Additional Inherited Members
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

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

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

key stream session

Definition at line 38 of file app-key-stream.h.

Member Enumeration Documentation

◆ Type

enum ns3::KeyStreamSession::Type

Enumerator
EMPTY
ENCRYPTION
AUTHENTICATION

Definition at line 41 of file app-key-stream.h.

Constructor & Destructor Documentation

◆ KeyStreamSession()

ns3::KeyStreamSession::KeyStreamSession ( )

inline

Definition at line 48 of file app-key-stream.h.

Member Function Documentation

◆ AddKey()

void ns3::KeyStreamSession::AddKey ( Ptr< AppKey > key )

inline

Definition at line 66 of file app-key-stream.h.

References m_stream.

◆ ClearStream()

void ns3::KeyStreamSession::ClearStream ( )

inline

Definition at line 118 of file app-key-stream.h.

References m_id, m_stream, and m_verified.

◆ GetId()

std::string ns3::KeyStreamSession::GetId ( ) const

inline

Definition at line 54 of file app-key-stream.h.

References m_id.

◆ GetKey()

Ptr< AppKey > ns3::KeyStreamSession::GetKey ( uint32_t packetSize = 0 )

inline

Definition at line 70 of file app-key-stream.h.

References ns3::Create(), ENCRYPTION, GetType(), m_stream, and packetSize.

Here is the call graph for this function:

◆ GetKeyCount()

uint32_t ns3::KeyStreamSession::GetKeyCount ( ) const

inline

Definition at line 87 of file app-key-stream.h.

References m_stream.

◆ GetSize()

uint32_t ns3::KeyStreamSession::GetSize ( ) const

inline

Definition at line 95 of file app-key-stream.h.

References m_size.

◆ GetType()

Type ns3::KeyStreamSession::GetType ( ) const

inline

Definition at line 114 of file app-key-stream.h.

References m_type.

Referenced by GetKey().

Here is the caller graph for this function:

◆ IsVerified()

bool ns3::KeyStreamSession::IsVerified ( ) const

inline

Definition at line 62 of file app-key-stream.h.

References m_verified.

◆ SetId()

void ns3::KeyStreamSession::SetId ( std::string ksid )

inline

Definition at line 50 of file app-key-stream.h.

References m_id.

◆ SetSize()

void ns3::KeyStreamSession::SetSize ( uint32_t size )

inline

Definition at line 91 of file app-key-stream.h.

References m_size.

◆ SetType()

void ns3::KeyStreamSession::SetType ( Type type )

inline

Definition at line 110 of file app-key-stream.h.

References m_type.

◆ SetVerified()

void ns3::KeyStreamSession::SetVerified ( bool isVerified )

inline

Definition at line 58 of file app-key-stream.h.

References ns3::Create(), and m_verified.

Here is the call graph for this function:

◆ SyncStream()

bool ns3::KeyStreamSession::SyncStream ( uint32_t index )

inline

Definition at line 99 of file app-key-stream.h.

References ns3::Create(), and m_stream.

Here is the call graph for this function:

Member Data Documentation

◆ m_id

std::string ns3::KeyStreamSession::m_id

private

Definition at line 127 of file app-key-stream.h.

Referenced by ClearStream(), GetId(), and SetId().

◆ m_size

uint32_t ns3::KeyStreamSession::m_size

private

Definition at line 129 of file app-key-stream.h.

Referenced by GetSize(), and SetSize().

◆ m_stream

std::map<uint32_t, Ptr<AppKey> > ns3::KeyStreamSession::m_stream

private

Definition at line 131 of file app-key-stream.h.

Referenced by AddKey(), ClearStream(), GetKey(), GetKeyCount(), and SyncStream().

◆ m_type

Type ns3::KeyStreamSession::m_type

private

Definition at line 128 of file app-key-stream.h.

Referenced by GetType(), and SetType().

◆ m_verified

bool ns3::KeyStreamSession::m_verified

private

Definition at line 130 of file app-key-stream.h.

Referenced by ClearStream(), IsVerified(), and SetVerified().

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

src/qkd/model/app-key-stream.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ KeyStreamSession()

Member Function Documentation

◆ AddKey()

◆ ClearStream()

◆ GetId()

◆ GetKey()

◆ GetKeyCount()

◆ GetSize()

◆ GetType()

◆ IsVerified()

◆ SetId()

◆ SetSize()

◆ SetType()

◆ SetVerified()

◆ SyncStream()

Member Data Documentation

◆ m_id

◆ m_size

◆ m_stream

◆ m_type

◆ m_verified