openDAQ
Open data acquisition platform
IPacketBufferBuilder Struct Referenceabstract

Briefly. More...

+ Inheritance diagram for IPacketBufferBuilder:
+ Collaboration diagram for IPacketBufferBuilder:

Detailed Description

Briefly.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getContext (IContext **context)=0
 Gets the context pointer. More...
 
virtual ErrCode INTERFACE_FUNC setContext (IContext *context)=0
 Sets the context pointer. More...
 
virtual ErrCode INTERFACE_FUNC getSizeInBytes (SizeT *sizeInBytes)=0
 Gets the size of the underlying buffer in bytes. More...
 
virtual ErrCode INTERFACE_FUNC setSizeInBytes (SizeT sizeInBytes)=0
 Sets the size of the underlying buffer in bytes. More...
 
virtual ErrCode INTERFACE_FUNC build (IPacketBuffer **buffer)=0
 Builds the Packet Buffer with the internally specified size and context. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ build()

virtual ErrCode INTERFACE_FUNC build ( IPacketBuffer **  buffer)
pure virtual

Builds the Packet Buffer with the internally specified size and context.

Parameters
[out]bufferReturns the newly created buffer

◆ getContext()

virtual ErrCode INTERFACE_FUNC getContext ( IContext **  context)
pure virtual

Gets the context pointer.

Parameters
[out]contextThe returned ContextPtr

◆ getSizeInBytes()

virtual ErrCode INTERFACE_FUNC getSizeInBytes ( SizeT *  sizeInBytes)
pure virtual

Gets the size of the underlying buffer in bytes.

Parameters
[out]sizeInBytesValue of this variable will contain the size of the buffer in bytes

◆ setContext()

virtual ErrCode INTERFACE_FUNC setContext ( IContext context)
pure virtual

Sets the context pointer.

Parameters
contextThe pointer that will be set

◆ setSizeInBytes()

virtual ErrCode INTERFACE_FUNC setSizeInBytes ( SizeT  sizeInBytes)
pure virtual

Sets the size of the underlying buffer in bytes.

Parameters
sizeInBytesSets the size of the buffer in bytes