RobotRaconteur::PipeSubscriptionBase Class Reference

Base class for PipeSubscription. More...

#include <Subscription.h>

Inheritance diagram for RobotRaconteur::PipeSubscriptionBase:

Public Member Functions
size_t	Available ()
	Get the number of packets available to receive.
size_t	GetActivePipeEndpointCount ()
	Get the number of pipe endpoints currently connected.
bool	GetIgnoreReceived ()
	Get if incoming packets are currently being ignored.
void	SetIgnoreReceived (bool ignore)
	Set if incoming packets should be ignored.
void	Close ()
	Closes the pipe subscription.

Detailed Description

Base class for PipeSubscription.

Base class for templated PipeSubscription

Member Function Documentation

Available()

size_t RobotRaconteur::PipeSubscriptionBase::Available

(

)

Get the number of packets available to receive.

Use ReceivePacket(), TryReceivePacket(), or TryReceivePacketWait() to receive the packet

Returns

size_t

Close()

void RobotRaconteur::PipeSubscriptionBase::Close

(

)

Closes the pipe subscription.

Pipe subscriptions are automatically closed when the parent ServiceSubscription is closed or when the node is shut down.

GetActivePipeEndpointCount()

size_t RobotRaconteur::PipeSubscriptionBase::GetActivePipeEndpointCount

(

)

Get the number of pipe endpoints currently connected.

Returns

size_t The number of active pipe endpoints

GetIgnoreReceived()

bool RobotRaconteur::PipeSubscriptionBase::GetIgnoreReceived

(

)

Get if incoming packets are currently being ignored.

Returns

true Incoming packets are being ignored

false Incoming packets are not being ignored

SetIgnoreReceived()

void RobotRaconteur::PipeSubscriptionBase::SetIgnoreReceived

(

bool

ignore

)

Set if incoming packets should be ignored.

See PipeEndpoint::SetIgnoreReceived();

If true, receivedpackets will be ignored for all connected pipe endpoints

Parameters

ignore

---

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

• /builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/Subscription.h