eq::net::ConnectionDescription Class Reference
#include <connectionDescription.h>
Detailed Description
Describes the connection to a Node.
- See also:
- Node
Definition at line 22 of file connectionDescription.h.
Data Access | |
| std::strings are not public because of DLL allocation issues. | |
| void | setHostname (const std::string &hostname) |
| const std::string & | getHostname () const |
| void | setLaunchCommand (const std::string &launchCommand) |
| const std::string & | getLaunchCommand () const |
| virtual | ~ConnectionDescription () |
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. | |
Public Attributes | |
| ConnectionType | type |
| The network protocol for the connection. | |
| int32_t | bandwidth |
| The bandwidth in kilobyte per second for this connection. | |
| int32_t | launchTimeout |
| The amount of time in milliseconds to wait before a node is considered unreachable during start. | |
| union { | |
| struct { | |
| uint16_t port | |
| The listening port. | |
| } TCPIP | |
| struct { | |
| uint16_t port | |
| The listening port. | |
| } SDP | |
| }; | |
| char | launchCommandQuote |
| The character to quote the launch command arguments. | |
Member Function Documentation
| string eq::net::ConnectionDescription::toString | ( | ) | const |
| bool eq::net::ConnectionDescription::fromString | ( | std::string & | data | ) |
Reads the connection description from a string.
The string is consumed as the description is parsed.
- Parameters:
-
data the string containing the connection description.
- Returns:
trueif the information was read correctly,falseif not.
Definition at line 59 of file connectionDescription.cpp.
References bandwidth, eq::net::CONNECTIONTYPE_PIPE, eq::net::CONNECTIONTYPE_SDP, eq::net::CONNECTIONTYPE_TCPIP, launchCommandQuote, launchTimeout, port, and type.
Member Data Documentation
The network protocol for the connection.
Definition at line 35 of file connectionDescription.h.
Referenced by fromString().
The bandwidth in kilobyte per second for this connection.
Definition at line 38 of file connectionDescription.h.
Referenced by fromString().
| uint16_t eq::net::ConnectionDescription::port |
The listening port.
Definition at line 53 of file connectionDescription.h.
Referenced by fromString().
The documentation for this class was generated from the following files:
