CommunicationParameters Class Reference

Holds the communication parameter to configure the connection between senders and receiver. More...

Types
enum class	COMM_TYPE
	Lists the different types of communications available for Fusion module. More...

Functions
	CommunicationParameters ()
	Default constructor. All the parameters are set to their default and optimized values. More...
void	setForSharedMemory ()
	Setup the communication to used shared memory for intra process workflow, senders and receiver in different threads. More...
void	setForLocalNetwork (int port)
	Setup local Network connection information, sender side, only the port is required. More...
void	setForLocalNetwork (std::string ip_address, int port)
	Setup local Network connection information, receiver side, need the edge device IP and the port. More...
int	getPort ()
	This function returns the comm port used for streaming the data. More...
std::string	getIpAddress ()
	This function returns the IP address of the sender. More...
COMM_TYPE	getType ()
	This function returns the type of the used communication. More...

Detailed Description

Holds the communication parameter to configure the connection between senders and receiver.

Enumeration

COMM_TYPE

enum COMM_TYPE

strong

Lists the different types of communications available for Fusion module.

Enumerator
LOCAL_NETWORK	The sender and receiver are on the same local network and communicate by RTP. The communication can be affected by the local network load.
INTRA_PROCESS	Both sender and receiver are declared by the same process and can be in different threads. This type of communication is optimized.

Constructor and Destructor

CommunicationParameters()

CommunicationParameters

(

)

Default constructor. All the parameters are set to their default and optimized values.

Functions

setForSharedMemory()

void setForSharedMemory

(

)

Setup the communication to used shared memory for intra process workflow, senders and receiver in different threads.

setForLocalNetwork() [1/2]

void setForLocalNetwork

(

int

port

)

Setup local Network connection information, sender side, only the port is required.

setForLocalNetwork() [2/2]

void setForLocalNetwork	(	std::string	ip_address,
		int	port
	)

Setup local Network connection information, receiver side, need the edge device IP and the port.

getPort()

int getPort ( )

inline

This function returns the comm port used for streaming the data.

Returns

the port

getIpAddress()

std::string getIpAddress ( )

inline

This function returns the IP address of the sender.

Returns

the IP address

getType()

COMM_TYPE getType ( )

inline

This function returns the type of the used communication.

Returns

the COMM_TYPE of the communication used