Public Member Functions | Private Attributes
ros::TransportHints Class Reference

Provides a way of specifying network transport hints to ros::NodeHandle::subscribe() and someday ros::NodeHandle::advertise() More...

#include <transport_hints.h>

List of all members.

Public Member Functions

int getMaxDatagramSize ()
 Returns the maximum datagram size specified on this TransportHints, or 0 if no size was specified.
const M_stringgetOptions ()
 Returns the map of options created by other methods inside TransportHints.
bool getTCPNoDelay ()
 Returns whether or not this TransportHints has specified TCP_NODELAY.
const V_stringgetTransports ()
 Returns a vector of transports, ordered by preference.
TransportHintsmaxDatagramSize (int size)
 If a UDP transport is used, specifies the maximum datagram size.
TransportHintsreliable ()
 Specifies a reliable transport. Currently this means TCP.
TransportHintstcp ()
 Explicitly specifies the TCP transport.
TransportHintstcpNoDelay (bool nodelay=true)
 If a TCP transport is used, specifies whether or not to use TCP_NODELAY to provide a potentially lower-latency connection.
TransportHintsudp ()
 Explicitly specifies a UDP transport.
TransportHintsunreliable ()
 Specifies an unreliable transport. Currently this means UDP.

Private Attributes

M_string options_
V_string transports_

Detailed Description

Provides a way of specifying network transport hints to ros::NodeHandle::subscribe() and someday ros::NodeHandle::advertise()

Uses the named parameter idiom, allowing you to do things like:

ros::TransportHints()
        .unreliable()
        .maxDatagramSize(1000)
        .tcpNoDelay();

Hints for the transport type are used in the order they are specified, i.e. TransportHints().unreliable().reliable() specifies that you would prefer an unreliable transport, followed by a reliable one.

Definition at line 54 of file transport_hints.h.


Member Function Documentation

Returns the maximum datagram size specified on this TransportHints, or 0 if no size was specified.

Definition at line 123 of file transport_hints.h.

Returns the map of options created by other methods inside TransportHints.

Definition at line 160 of file transport_hints.h.

Returns whether or not this TransportHints has specified TCP_NODELAY.

Definition at line 91 of file transport_hints.h.

Returns a vector of transports, ordered by preference.

Definition at line 156 of file transport_hints.h.

If a UDP transport is used, specifies the maximum datagram size.

Parameters:
sizeThe size, in bytes

Definition at line 113 of file transport_hints.h.

Specifies a reliable transport. Currently this means TCP.

Definition at line 60 of file transport_hints.h.

Explicitly specifies the TCP transport.

Definition at line 70 of file transport_hints.h.

TransportHints& ros::TransportHints::tcpNoDelay ( bool  nodelay = true) [inline]

If a TCP transport is used, specifies whether or not to use TCP_NODELAY to provide a potentially lower-latency connection.

Parameters:
nodelay[optional] Whether or not to use TCP_NODELAY. Defaults to true.

Definition at line 82 of file transport_hints.h.

Explicitly specifies a UDP transport.

Definition at line 147 of file transport_hints.h.

Specifies an unreliable transport. Currently this means UDP.

Definition at line 137 of file transport_hints.h.


Member Data Documentation

Definition at line 164 of file transport_hints.h.

Definition at line 163 of file transport_hints.h.


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


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Tue Mar 7 2017 04:01:04