A publisher of messages on a topic.
More...
#include <transport/transport.hh>
A publisher of messages on a topic.
Publisher |
( |
const std::string & |
_topic, |
|
|
const std::string & |
_msgType, |
|
|
unsigned int |
_limit, |
|
|
double |
_hzRate |
|
) |
| |
Constructor.
- Parameters
-
[in] | _topic | Name of topic to be published |
[in] | _msgType | Type of the message to be published |
[in] | _limit | Maximum number of outgoing messages to queue |
[in] | _hz | Update rate for the publisher. Units are 1.0/seconds. |
std::string GetMsgType |
( |
| ) |
const |
Get the message type.
- Returns
- The message type
unsigned int GetOutgoingCount |
( |
| ) |
const |
Get the number of outgoing messages.
- Returns
- The number of outgoing messages
std::string GetPrevMsg |
( |
| ) |
const |
Get the previously published message.
- Returns
- The previously published message, if any
Get the previously published message.
- Returns
- The previously published message, if any
std::string GetTopic |
( |
| ) |
const |
Get the topic name.
- Returns
- The topic name
bool HasConnections |
( |
| ) |
const |
Are there any connections?
- Returns
- true if there are any connections, false otherwise
Get the id of this publisher.
- Returns
- Unique id of this publisher.
void Publish |
( |
const google::protobuf::Message & |
_message, |
|
|
bool |
_block = false |
|
) |
| |
|
inline |
Publish a protobuf message on the topic.
- Parameters
-
[in] | _message | Message to be published |
[in] | _block | Whether to block until the message is actually written out |
void Publish |
( |
M |
_message, |
|
|
bool |
_block = false |
|
) |
| |
|
inline |
Publish an arbitrary message on the topic.
- Parameters
-
[in] | _message | Message to be published |
[in] | _block | Whether to block until the message is actually written out |
Send latest message over the wire. For internal use only.
Set our containing node.
- Parameters
-
[in] | _node | Pointer to a node. Should be the node that create this publisher. |
Set the publication object for a particular publication.
- Parameters
-
[in] | _publication | Pointer to the publication object to be set |
void WaitForConnection |
( |
| ) |
const |
Block until a connection has been established with this publisher.
bool WaitForConnection |
( |
const common::Time & |
_timeout | ) |
const |
Block until a connection has been established with this publisher.
- Parameters
-
[in] | _timeout | Maxiumum time to wait. Use a negative time value to wait forever. |
- Returns
- True if a connection was established.
The documentation for this class was generated from the following file: