Describes Connection parameters. More...

#include <connectionDescription.h>

Inheritance diagram for co::ConnectionDescription:

Collaboration diagram for co::ConnectionDescription:

Public Member Functions
	ConnectionDescription ()
	Construct a new, default description. More...

	ConnectionDescription (std::string &data)
	Construct a description from a string representation. More...

CO_API void	serialize (std::ostream &os) const
	Serialize this description to a std::ostream. More...

CO_API std::string	toString () const

CO_API bool	fromString (std::string &data)
	Read the connection description from a string. More...

Data Access
CO_API bool	isSameMulticastGroup (ConstConnectionDescriptionPtr rhs)

CO_API bool	operator== (const ConnectionDescription &rhs) const

bool	operator!= (const ConnectionDescription &rhs) const

Deprecated Data Access
Deprecated:
CO_API void	setHostname (const std::string &hostname)

CO_API const std::string &	getHostname () const

CO_API void	setInterface (const std::string &interfacename)

CO_API const std::string &	getInterface () const

CO_API void	setFilename (const std::string &filename)

CO_API const std::string &	getFilename () const

Public Attributes
ConnectionType	type
	The network protocol for the connection. More...

int32_t	bandwidth
	The bandwidth in kilobyte per second. More...

uint16_t	port
	The listening port (TCPIP, IB, MCIP, RDMA). More...

std::string	hostname
	The hostname to bind or connect to. More...

std::string	interfacename
	The host name of the interface (multicast). More...

std::string	filename
	The filename used for named pipes. More...

Static Public Attributes
static const uint16_t	RANDOM_MULTICAST_PORT = 1
	Use a random, instead of fixed, multicast port. More...

Detailed Description

Describes Connection parameters.

Definition at line 32 of file connectionDescription.h.

Constructor & Destructor Documentation

co::ConnectionDescription::ConnectionDescription ( )

inline

Construct a new, default description.

Version: 1.0

Definition at line 57 of file connectionDescription.h.

References fromString(), operator==(), serialize(), and toString().

Here is the call graph for this function:

co::ConnectionDescription::ConnectionDescription ( std::string & data )

explicit

Construct a description from a string representation.

The given data is consumed, that is, the data string should be empty on return when a single description was given.

See also: fromString()

Version: 1.0

Member Function Documentation

CO_API bool co::ConnectionDescription::fromString ( std::string & data )

Read the connection description from a string.

The string is consumed as the description is parsed. Two different formats are recognized, a human-readable and a machine-readable. The human-readable version has the format hostname[:port][:type] or filename:PIPE. The type parameter can be TCPIP, IB, MCIP, UDT or RSP. The machine-readable format contains all connection description parameters, is not documented and subject to change.

Parameters