RobotRaconteur::PipeBase Class Reference

Base class for Pipe. More...

#include <PipeMember.h>

Inheritance diagram for RobotRaconteur::PipeBase:

Public Member Functions
virtual std::string	GetMemberName ()=0
	Get the member name of the pipe.
MemberDefinition_Direction	Direction ()
	The direction of the pipe.
bool	IsUnreliable ()
	Get if pipe is declared unreliable.

Static Public Attributes
static const int32_t	ANY_INDEX = -1
	Dynamically select pipe endpoint index.

Detailed Description

Base class for Pipe.

Base class for templated Pipe

Member Function Documentation

Direction()

MemberDefinition_Direction RobotRaconteur::PipeBase::Direction

(

)

The direction of the pipe.

Pipes may be declared readonly or writeonly in the service definition file. (If neither is specified, the pipe is assumed to be full duplex.) readonly pipes may only send packets from service to client. writeonly pipes may only send packets from client to service.

Returns

MemberDefinition_Direction

GetMemberName()

virtual std::string RobotRaconteur::PipeBase::GetMemberName ( )

pure virtual

Get the member name of the pipe.

Returns

std::string

IsUnreliable()

bool RobotRaconteur::PipeBase::IsUnreliable

(

)

Get if pipe is declared unreliable.

Pipe members may be declared as unreliable using member modifiers in the service definition. Pipes confirm unreliable operation when pipe endpoints are connected.

Returns

true The pipe is declared unreliable

false The pipe is declared reliable

Member Data Documentation

ANY_INDEX

const int32_t RobotRaconteur::PipeBase::ANY_INDEX = -1

static

Dynamically select pipe endpoint index.

Pass to Connect() or AsyncConnect() to use any available endpoint index

---

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/PipeMember.h