co::ConnectionDescription Class Reference

Describes Connection parameters. More...

#include <connectionDescription.h>

Inheritance diagram for co::ConnectionDescription:

Collaboration diagram for co::ConnectionDescription:

List of all members.

Public Member Functions
	ConnectionDescription (const char *data)
CO_API bool	operator== (const ConnectionDescription &rhs) const
bool	operator!= (const ConnectionDescription &rhs) const
CO_API std::string	toString () const
CO_API void	serialize (std::ostream &os) const
CO_API bool	fromString (std::string &data)
	Reads the connection description from a string.
Data Access
std::strings are not public because of DLL allocation issues.
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
CO_API bool	isSameMulticastGroup (ConnectionDescriptionPtr rhs)
Static Public Member Functions
static CO_API const std::string &	getSAttributeString (const SAttribute attr)
static CO_API const std::string &	getIAttributeString (const IAttribute attr)
Public Attributes
ConnectionType	type
	The network protocol for the connection.
int32_t	bandwidth
	The bandwidth in kilobyte per second for this connection.
uint16_t	port
	The listening port (TCPIP, SDP, IB, MCIP).
Public Types
Attributes
enum	SAttribute {   SATTR_HOSTNAME, SATTR_FILENAME, SATTR_FILL1, SATTR_FILL2,   SATTR_ALL }
	String attributes.
enum	IAttribute {   IATTR_TYPE, IATTR_PORT, IATTR_BANDWIDTH, IATTR_FILL1,   IATTR_FILL2, IATTR_ALL }
	Integer attributes.

---

Detailed Description

Describes Connection parameters.

See also:

Node

Definition at line 35 of file connectionDescription.h.

---

Member Function Documentation

CO_API bool co::ConnectionDescription::fromString

(

std::string &

data

)

Reads 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, SDP, IB, MCIP, PGM or RSP. The machine-readable format contains all connection description parameters and is not documented.

Parameters:

data	the string containing the connection description.

Returns:

true if the information was read correctly, false if not.

bool co::ConnectionDescription::operator!=

(

const ConnectionDescription &

rhs

)

const [inline]

Returns:

true if the two descriptions have the different values.

Definition at line 51 of file connectionDescription.h.

CO_API bool co::ConnectionDescription::operator==

(

const ConnectionDescription &

rhs

)

const

Returns:

true if the two descriptions have the same values.

CO_API std::string co::ConnectionDescription::toString

(

)

const

Returns:

this description as a string.

---

Member Data Documentation

int32_t co::ConnectionDescription::bandwidth

The bandwidth in kilobyte per second for this connection.

Definition at line 58 of file connectionDescription.h.

uint16_t co::ConnectionDescription::port

The listening port (TCPIP, SDP, IB, MCIP).

Definition at line 61 of file connectionDescription.h.

ConnectionType co::ConnectionDescription::type

The network protocol for the connection.

Definition at line 55 of file connectionDescription.h.

---

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

• connectionDescription.h