eq::net::ConnectionDescription Class Reference

Describes Connection parameters. More...

#include <connectionDescription.h>

Inheritance diagram for eq::net::ConnectionDescription:

[legend]

Collaboration diagram for eq::net::ConnectionDescription:

[legend]

List of all members.

Public Member Functions
std::string	toString () const
void	serialize (std::ostream &os) const
bool	fromString (std::string &data)
	Reads the connection description from a string.
Data Access
std::strings are not public because of DLL allocation issues.
void	setHostname (const std::string &hostname)
const std::string &	getHostname () const
void	setInterface (const std::string &interface)
const std::string &	getInterface () const
void	setFilename (const std::string &filename)
const std::string &	getFilename () const
bool	isSameMulticastGroup (ConnectionDescriptionPtr rhs)
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).

Detailed Description

Describes Connection parameters.

See also:: Node

Definition at line 36 of file lib/net/connectionDescription.h.

Member Function Documentation

string eq::net::ConnectionDescription::toString ( ) const

Returns:: this description as a string.

Definition at line 61 of file lib/net/connectionDescription.cpp.

bool eq::net::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.