Private data for the Node class. This class should not be directly used. You should use the Node class.
More...
#include <ignition/transport/NodeShared.hh>
|
bool | AdvertisePublisher (const ServicePublisher &_publisher) |
| Pass through to bool Advertise(const Pub &_publisher) More...
|
|
HandlerInfo | CheckHandlerInfo (const std::string &_topic) const |
| Get information about the local and raw subscribers that are attached to this NodeShared. More...
|
|
SubscriberInfo | CheckSubscriberInfo (const std::string &_topic, const std::string &_msgType) const |
| Get information about the nodes that are subscribed to the publishers of this NodeShared. More...
|
|
bool | DiscoverService (const std::string &_topic) const |
| Pass through to bool Discovery::Discover(const std::string &_topic) const. More...
|
|
void | OnNewConnection (const MessagePublisher &_pub) |
| Callback executed when the discovery detects new topics. More...
|
|
void | OnNewDisconnection (const MessagePublisher &_pub) |
| Callback executed when the discovery detects disconnections. More...
|
|
void | OnNewSrvConnection (const ServicePublisher &_pub) |
| Callback executed when the discovery detects a new service call. More...
|
|
void | OnNewSrvDisconnection (const ServicePublisher &_pub) |
| Callback executed when a service call is no longer available. More...
|
|
bool | Publish (const std::string &_topic, char *_data, const size_t _dataSize, DeallocFunc *_ffn, const std::string &_msgType) |
| Publish data. More...
|
|
void | RecvControlUpdate () |
| Method in charge of receiving the control updates (when a new remote subscriber notifies its presence for example). More...
|
|
void | RecvMsgUpdate () |
| Method in charge of receiving the topic updates. More...
|
|
void | RecvSrvRequest () |
| Method in charge of receiving the service call requests. More...
|
|
void | RecvSrvResponse () |
| Method in charge of receiving the service call responses. More...
|
|
void | RunReceptionTask () |
| Receive data and control messages. More...
|
|
void | SendPendingRemoteReqs (const std::string &_topic, const std::string &_reqType, const std::string &_repType) |
| Try to send all the requests for a given service call and a pair of request/response types. More...
|
|
bool | TopicPublishers (const std::string &_topic, SrvAddresses_M &_publishers) const |
| Pass through to bool Publishers(const std::string &_topic, Addresses_M<Pub> &_publishers) const. More...
|
|
void | TriggerSubscriberCallbacks (const std::string &_topic, const std::string &_msgData, const std::string &_msgType, const HandlerInfo &_handlerInfo) |
| Call the SubscriptionHandler callbacks (local and raw) for this NodeShared. More...
|
|
Private data for the Node class. This class should not be directly used. You should use the Node class.
◆ NodeShared()
◆ ~NodeShared()
◆ AdvertisePublisher()
Pass through to bool Advertise(const Pub &_publisher)
- Parameters
-
[in] | _publisher | Publisher's information to advertise. |
- Returns
- True if the method succeed or false otherwise (e.g. if the discovery has not been started).
- See also
- Pass through to bool Advertise(const Pub &_publisher)
◆ CheckHandlerInfo()
Get information about the local and raw subscribers that are attached to this NodeShared.
- Parameters
-
[in] | _topic | Information will only be returned for handlers that are subscribed to the given topic name. |
- Returns
- Information about local subscription handlers that are held by this NodeShared.
◆ CheckSubscriberInfo()
Get information about the nodes that are subscribed to the publishers of this NodeShared.
- Parameters
-
[in] | _topic | Only information about subscribers to this topic will be returned. |
[in] | _msgType | If there are no remote subscribers listening for this message type, then SubscriberInfo::haveRemote will be false in the return value of this function. |
- Returns
- Information about subscribers.
◆ DiscoverService()
bool DiscoverService |
( |
const std::string & |
_topic | ) |
const |
◆ Instance()
◆ OnNewConnection()
Callback executed when the discovery detects new topics.
- Parameters
-
[in] | _pub | Information of the publisher in charge of the topic. |
◆ OnNewDisconnection()
Callback executed when the discovery detects disconnections.
- Parameters
-
[in] | _pub | Information of the publisher in charge of the topic. |
◆ OnNewSrvConnection()
Callback executed when the discovery detects a new service call.
- Parameters
-
[in] | _pub | Information of the publisher in charge of the service. |
◆ OnNewSrvDisconnection()
Callback executed when a service call is no longer available.
- Parameters
-
[in] | _pub | Information of the publisher in charge of the service. |
◆ Publish()
Publish data.
- Parameters
-
[in] | _topic | Topic to be published. |
[in,out] | _data | Serialized data. Note that this buffer will be automatically deallocated by ZMQ when all data has been published. |
[in] | _dataSize | Data size (bytes). |
[in,out] | _ffn | Deallocation function. This function is executed by ZeroMQ when the data is published. This function deallocates the buffer containing the published data. http://zeromq.org/blog:zero-copy |
[in] | _msgType | Message type in string format. |
- Returns
- true when success or false otherwise.
◆ RecvControlUpdate()
void RecvControlUpdate |
( |
| ) |
|
Method in charge of receiving the control updates (when a new remote subscriber notifies its presence for example).
◆ RecvMsgUpdate()
Method in charge of receiving the topic updates.
◆ RecvSrvRequest()
Method in charge of receiving the service call requests.
◆ RecvSrvResponse()
Method in charge of receiving the service call responses.
◆ RunReceptionTask()
void RunReceptionTask |
( |
| ) |
|
Receive data and control messages.
◆ SendPendingRemoteReqs()
Try to send all the requests for a given service call and a pair of request/response types.
- Parameters
-
[in] | _topic | Topic name. |
[in] | _reqType | Type of the request in string format. |
[in] | _repType | Type of the response in string format. |
◆ TopicPublishers()
Pass through to bool Publishers(const std::string &_topic, Addresses_M<Pub> &_publishers) const.
- Parameters
-
[in] | _topic | Service name. |
[out] | _publishers | Collection of service publishers. |
- Returns
- True if the service is found and
- See also
- bool Publishers(const std::string &_topic, Addresses_M<Pub> &_publishers) const
◆ TriggerSubscriberCallbacks()
◆ hostAddr
◆ kMsgDiscPort
const int kMsgDiscPort = 11317 |
|
static |
Port used by the message discovery layer.
◆ kSrvDiscPort
const int kSrvDiscPort = 11318 |
|
static |
Port used by the service discovery layer.
◆ localSubscribers
◆ mutex
Mutex to guarantee exclusive access between all threads.
◆ myAddress
◆ myControlAddress
My pub/sub control address.
◆ myReplierAddress
My replier service call address.
◆ myRequesterAddress
My requester service call address.
◆ pUuid
◆ remoteSubscribers
◆ replierId
◆ repliers
◆ requests
Pending service call requests.
◆ responseReceiverId
Response receiver socket identity.
◆ threadReception
thread in charge of receiving and handling incoming messages.
◆ verbose
Print activity to stdout.
The documentation for this class was generated from the following file: