Initializer Class Reference

This class initializes the API. More...

#include <initializer.h>

Public Types
typedef NIC< SocketEngine >	NIC_T
typedef Protocol< NIC_T >	Protocol_T
typedef Communicator< Protocol_T >	Communicator_T
typedef Communicator_T::Message_T	Message

Public Member Functions
	Initializer ()=default
	~Initializer ()=default

Static Public Member Functions
static NIC_T *	create_nic ()
	Creates a network interface abstraction.
static Protocol_T *	create_protocol (NIC_T *nic)
	Creates a protocol for system communication.
static Protocol_T *	create_protocol (NIC_T *nic, Protocol_T::EntityType entity_type)

Detailed Description

This class initializes the API.

This class is only responsible for starting the API. It allows you to create a network interface (NIC) and a protocol, which will be used in the system. The idea is that it is independent of the application in which the developer will use the API.

Member Typedef Documentation

Communicator_T

typedef Communicator<Protocol_T> Initializer::Communicator_T

Message

typedef Communicator_T::Message_T Initializer::Message

NIC_T

typedef NIC<SocketEngine> Initializer::NIC_T

Protocol_T

typedef Protocol<NIC_T> Initializer::Protocol_T

Constructor & Destructor Documentation

Initializer()

Initializer::Initializer ( )

default

~Initializer()

Initializer::~Initializer ( )

default

Member Function Documentation

create_nic()

Initializer::NIC_T * Initializer::create_nic ( )

inlinestatic

Creates a network interface abstraction.

Returns

The created NIC

create_protocol() [1/2]

Initializer::Protocol_T * Initializer::create_protocol ( NIC_T *  nic )

inlinestatic

Creates a protocol for system communication.

Parameters

nic	a previously created network interface

Returns

The created Protocol, associated with the network interface passed as a parameter

create_protocol() [2/2]

Initializer::Protocol_T * Initializer::create_protocol ( NIC_T *  nic, Protocol_T::EntityType  entity_type  )

inlinestatic

---

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

• include/api/network/initializer.h