libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
BaseLib::Rpc::BinaryRpc Class Reference

#include <BinaryRpc.h>

Public Types

enum  Type { Type::unknown, Type::request, Type::response }
 

Public Member Functions

 BinaryRpc ()
 
 BinaryRpc (BaseLib::SharedObjects *bl)
 Deprecated old constructor. More...
 
 ~BinaryRpc ()=default
 
size_t getMaxHeaderSize ()
 
void setMaxHeaderSize (size_t value)
 
size_t getMaxContentSize ()
 
void setMaxContentSize (size_t value)
 
Type getType ()
 
bool hasHeader ()
 
bool processingStarted ()
 
bool headerProcessingStarted ()
 
bool dataProcessingStarted ()
 
bool isFinished ()
 
std::vector< char > & getData ()
 
void reset ()
 
int32_t process (char *buffer, int32_t bufferLength)
 Parses binary RPC data from a buffer. More...
 

Member Enumeration Documentation

§ Type

Enumerator
unknown 
request 
response 

Constructor & Destructor Documentation

§ BinaryRpc() [1/2]

BaseLib::Rpc::BinaryRpc::BinaryRpc ( )

§ BinaryRpc() [2/2]

BaseLib::Rpc::BinaryRpc::BinaryRpc ( BaseLib::SharedObjects bl)
explicit

Deprecated old constructor.

§ ~BinaryRpc()

BaseLib::Rpc::BinaryRpc::~BinaryRpc ( )
default

Member Function Documentation

§ dataProcessingStarted()

bool BaseLib::Rpc::BinaryRpc::dataProcessingStarted ( )
inline

§ getData()

std::vector<char>& BaseLib::Rpc::BinaryRpc::getData ( )
inline

§ getMaxContentSize()

size_t BaseLib::Rpc::BinaryRpc::getMaxContentSize ( )
inline

§ getMaxHeaderSize()

size_t BaseLib::Rpc::BinaryRpc::getMaxHeaderSize ( )
inline

§ getType()

Type BaseLib::Rpc::BinaryRpc::getType ( )
inline

§ hasHeader()

bool BaseLib::Rpc::BinaryRpc::hasHeader ( )
inline

§ headerProcessingStarted()

bool BaseLib::Rpc::BinaryRpc::headerProcessingStarted ( )
inline

§ isFinished()

bool BaseLib::Rpc::BinaryRpc::isFinished ( )
inline

§ process()

int32_t BaseLib::Rpc::BinaryRpc::process ( char *  buffer,
int32_t  bufferLength 
)

Parses binary RPC data from a buffer.

Parameters
bufferThe buffer to parse
bufferLengthThe maximum number of bytes to process.
Returns
The number of processed bytes.

§ processingStarted()

bool BaseLib::Rpc::BinaryRpc::processingStarted ( )
inline

§ reset()

void BaseLib::Rpc::BinaryRpc::reset ( )

§ setMaxContentSize()

void BaseLib::Rpc::BinaryRpc::setMaxContentSize ( size_t  value)
inline

§ setMaxHeaderSize()

void BaseLib::Rpc::BinaryRpc::setMaxHeaderSize ( size_t  value)
inline

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