eq::net::ConnectionDescription Class Reference
Describes Connection parameters. More...
#include <connectionDescription.h>
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 | setLaunchCommand (const std::string &launchCommand) |
| const std::string & | getLaunchCommand () const |
| void | setFilename (const std::string &filename) |
| const std::string & | getFilename () const |
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 | |
| TCP/IP parameters. | |
| struct { | |
| uint16_t port | |
| The listening port. | |
| } SDP | |
| }; | |
| The individual parameters for the connection. | |
| char | launchCommandQuote |
| The character to quote the launch command arguments. | |
Detailed Description
Describes Connection parameters.
- See also:
- Node
Definition at line 35 of file lib/net/connectionDescription.h.
Member Function Documentation
| string eq::net::ConnectionDescription::toString | ( | ) | const |
- Returns:
- this description as a string.
Definition at line 31 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.
- Parameters:
-
data the string containing the connection description.
- Returns:
trueif the information was read correctly,falseif not.
Definition at line 79 of file lib/net/connectionDescription.cpp.
References bandwidth, eq::net::CONNECTIONTYPE_NAMEDPIPE, eq::net::CONNECTIONTYPE_PIPE, eq::net::CONNECTIONTYPE_SDP, eq::net::CONNECTIONTYPE_TCPIP, EQWARN, launchCommandQuote, launchTimeout, port, TCPIP, and type.
Member Data Documentation
The network protocol for the connection.
Definition at line 48 of file lib/net/connectionDescription.h.
Referenced by fromString().
The bandwidth in kilobyte per second for this connection.
Definition at line 51 of file lib/net/connectionDescription.h.
Referenced by fromString().
| uint16_t eq::net::ConnectionDescription::port |
The listening port.
Definition at line 66 of file lib/net/connectionDescription.h.
Referenced by fromString().
| union { ... } |
The individual parameters for the connection.
The documentation for this class was generated from the following files:
