rasdaman complete source
Public Member Functions | List of all members
rnp::RnpTransmitter Class Reference

#include <rnpembedded.hh>

Inheritance diagram for rnp::RnpTransmitter:
rnp::RnpProtocolEncoder

Public Member Functions

 RnpTransmitter () throw ()
 Default constructor. More...
 
 ~RnpTransmitter () throw ()
 Destructor. More...
 
bool startRequest (RnpQuark serverType, RnpTransport::CarrierProtocol) throw ()
 Starts a new message, as a request, embedded in a specified protocol. More...
 
bool startAnswer (RnpQuark serverType, RnpTransport::CarrierProtocol) throw ()
 Starts a new message, as an answer, embedded in a specified protocol. More...
 
akg::CommBuffer * endMessage () throw ()
 ends the message, puts the carrier headers and, if requested, changes endianness More...
 
RnpTransport::CarrierProtocol getCarrierProtocol () throw ()
 Returns the carrier protocol. More...
 
int getBufferSize () const throw ()
 Returns the total size of the buffer. More...
 
int getNotFilledSize () const throw ()
 Return the space left in the buffer. More...
 
int getDataSize () const throw ()
 Returns the data size in the buffer. More...
 
- Public Member Functions inherited from rnp::RnpProtocolEncoder
 RnpProtocolEncoder () throw ()
 Default constructor. More...
 
 ~RnpProtocolEncoder () throw ()
 Destructor. More...
 
void setBuffer (akg::CommBuffer *) throw ()
 Sets an external buffer as work buffer. More...
 
bool allocateBuffer (int maxMessageLength) throw ()
 Allocates an internal buffer as work buffer. More...
 
bool adjustBufferSize (int differenceSize) throw ()
 
int getBufferSize () throw ()
 
void startMessage (RnpQuark serverType, int carrierHeaderSize=0) throw ()
 
void setDesiredEndianness (Rnp::Endianness) throw ()
 
void setFinalEndianness (Rnp::Endianness) throw ()
 
void startFragment (Rnp::FragmentType, RnpQuark command) throw ()
 Starts a new fragment. More...
 
void addStringParameter (RnpQuark parameterType, const char *) throw ()
 Adds a string parameter to the current fragment. More...
 
void addInt32Parameter (RnpQuark parameterType, int) throw ()
 Adds an int parameter to the current fragment. More...
 
void addFloat32Parameter (RnpQuark parameterType, float) throw ()
 Adds a float parameter to the current fragment. More...
 
void addDouble64Parameter (RnpQuark parameterType, double) throw ()
 Adds a double parameter to the current fragment. More...
 
void addOpaqueParameter (RnpQuark parameterType, const void *, int size) throw ()
 Adds an opaque parameter to the current fragment. More...
 
void endFragment () throw ()
 Ends the current fragment. More...
 
akg::CommBuffer * endMessage () throw ()
 Ends the message and, if necessary, changes the endianness. More...
 
int getCarrierHeaderSize () throw ()
 Returns the size of the reserved space for the embedding carrier header. More...
 

Additional Inherited Members

- Protected Attributes inherited from rnp::RnpProtocolEncoder
akg::CommBuffer * commBuffer
 

Detailed Description

Class for creating an embedded RNP message. Most methods are inherited from RnpProtocolEncoder, it offers just convenient methods for dealing with carriers

Constructor & Destructor Documentation

rnp::RnpTransmitter::RnpTransmitter ( )
throw (
)

Default constructor.

rnp::RnpTransmitter::~RnpTransmitter ( )
throw (
)

Destructor.

Member Function Documentation

akg::CommBuffer* rnp::RnpTransmitter::endMessage ( )
throw (
)

ends the message, puts the carrier headers and, if requested, changes endianness

int rnp::RnpTransmitter::getBufferSize ( ) const
throw (
)

Returns the total size of the buffer.

RnpTransport::CarrierProtocol rnp::RnpTransmitter::getCarrierProtocol ( )
throw (
)

Returns the carrier protocol.

int rnp::RnpTransmitter::getDataSize ( ) const
throw (
)

Returns the data size in the buffer.

int rnp::RnpTransmitter::getNotFilledSize ( ) const
throw (
)

Return the space left in the buffer.

bool rnp::RnpTransmitter::startAnswer ( RnpQuark  serverType,
RnpTransport::CarrierProtocol   
)
throw (
)

Starts a new message, as an answer, embedded in a specified protocol.

bool rnp::RnpTransmitter::startRequest ( RnpQuark  serverType,
RnpTransport::CarrierProtocol   
)
throw (
)

Starts a new message, as a request, embedded in a specified protocol.


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