WOscBlob Class Reference

#include <WOscBlob.h>

List of all members.

Public Types
enum	Constants { BLOB_SIZE_SIZE = 4 }
Public Member Functions
	WOscBlob (const char *binaryData)
	WOscBlob (const char *binaryData, int dataLen)
	WOscBlob (WOscBlob *b)
	WOscBlob (WOscBlob &b)
virtual	~WOscBlob ()
WOscBlob &	operator= (WOscBlob &rhs)
int	GetDataLen () const
const char *	GetData () const
int	GetBufferLen () const
void	GetBuffer (char *buffer, int bufferLen) const
const char *	GetBuffer () const

---

Detailed Description

Encapsulates an OSC-blob for transmission of binary data. Used to transport proprietary data over the OSC-protocol. Inherit your own class from this object, for instance a firmware-packet class, which could transport binary data fo firmware updates.

Remarks:

When using datagram transmission, make sure that the receive-buffer of the other peer can handle your OSC-packet size (most systems can handle UDP datagram-packets of sizes up to 512bytes)

Todo:

Change GetBufferLen to getDataLenZeroPadded

Definition at line 61 of file WOscBlob.h.

---

Member Enumeration Documentation

enum WOscBlob::Constants

Enumerator:

BLOB_SIZE_SIZE

Size of blob's size.

Definition at line 78 of file WOscBlob.h.

                  {
        BLOB_SIZE_SIZE = 4,     /**< Size of blob's size. */
    };

---

Constructor & Destructor Documentation

WOscBlob::WOscBlob

(

const char *

binaryData

)

Constructor for WOscBlobs from a binary buffer containing an WOscBlob in its binary representation ( [blobsize][blobdata] ).

Parameters:

binaryData

Pointer to the buffer containing the raw data.

Remarks:

Does not handle illegal blob sizes when passing wrong buffers.

Definition at line 56 of file WOscBlob.cpp.

References BLOB_SIZE_SIZE, WOscUtil::GetSizeFourByteAligned(), and WOscBlob().

Referenced by WOscBlob().

{
    // get blob size
    m_dataLen = WOscUtil::BufferTo<int>(binaryData);
    m_bufferLen = WOscUtil::GetSizeFourByteAligned( m_dataLen ) + BLOB_SIZE_SIZE;
    m_buffer = new char[m_bufferLen] ;

    // write data to buffer 
    memcpy(m_buffer, binaryData, m_bufferLen);
}

WOscBlob::WOscBlob	(	const char *	binaryData,
		int	dataLen
	)

Constructs a WOscBlob-object from a binary buffer. The buffer is internally rounded up to a multiple of 4. If querying fo buffer size, the padded size is returned. To get the actual data length, use the GetDataLen() function.

Parameters:

	binaryData	Buffer with data of length "dataLen".
	dataLen	Length of data supplied with "binaryData".

Exceptions:

None.

Remarks:

Check general information at WOscBlob .

 
 +-------------------+----//---------------------+
 | size of blob data | blob data + padding zeros |
 +-------------------+---------------------------+

 |----- 4 bytes -----|-- size rounded up bytes --|

   

Definition at line 107 of file WOscBlob.cpp.

References BLOB_SIZE_SIZE, WOscUtil::GetSizeFourByteAligned(), and WOscBlob().

{
    m_dataLen = dataLen;

    /* round up and allocate */
    m_bufferLen = WOscUtil::GetSizeFourByteAligned(dataLen) + BLOB_SIZE_SIZE;
    m_buffer = new char[m_bufferLen];
    
    /* write size to buffer */
    WOscUtil::FillBufferWith(m_buffer, dataLen);
    
    /* write data to buffer */
    memcpy(m_buffer + BLOB_SIZE_SIZE, binaryData, m_dataLen);

    /* zeropad buffer */
    for ( int i = m_dataLen + BLOB_SIZE_SIZE; i < m_bufferLen; i++ )
        m_buffer[i] = 0;
}

WOscBlob::WOscBlob

(

WOscBlob *

b

)

Pointer-copy-constructor. Copies the content of the referenced blob into this one.

Parameters:

b

Reference to another blob.

Exceptions:

None.

Remarks:

None.

Definition at line 160 of file WOscBlob.cpp.

References WOscBlob().

{
    m_buffer = NULL;
    *this = *b;
}

WOscBlob::WOscBlob

(

WOscBlob &

b

)

Copy-constructor. Copies the content of the referenced blob into this one.

Parameters:

b

Reference to another blob.

Exceptions:

None.

Remarks:

None.

Definition at line 177 of file WOscBlob.cpp.

References WOscBlob().

{
    m_buffer = NULL;
    *this = b;
}

WOscBlob::~WOscBlob

(

)

[virtual]

Deletes the WOscBlob-object. The internal buffer gets deleted.

Exceptions:

None.

Remarks:

None.

Definition at line 191 of file WOscBlob.cpp.

{
    delete [] m_buffer;
}

---

Member Function Documentation

const char * WOscBlob::GetBuffer

(

)

const

Returns a pointer to an internal buffer containing the current binary representation of this blob. Please see remarks for safety issues.

Returns:

Pointer to internal array data.

Exceptions:

None.

Remarks:

The pointer remains valid until the modification of this blob-object. The next time the blob is destination of an operation (check operators) or the blob will be deleted this pointer gets invalid. If you are not sure about that issue, please use the other getBuffer()- function.

See also:

WOscBlob::getBuffer(char* buffer, int bufferLen)

Definition at line 271 of file WOscBlob.cpp.

{
    return m_buffer;
}

void WOscBlob::GetBuffer	(	char *	buffer,
		int	bufferLen
	)			const

Fills the buffer with the raw bytestream of this blob. The user must supply the buffer of apropriate size.

Parameters:

	buffer	Caller supplied destination buffer.
	bufferLen	Length of the supplied buffer.

Exceptions:

WOscException

When caller supplied buffer too small.

Remarks:

This interface makes sure that the buffer remains valid when modifying the blob-object afterwards. (contrary to WOscBlob::getBuffer() )

See also:

WOscBlob::getBuffer()

Definition at line 246 of file WOscBlob.cpp.

References ERR_BUFFER_TO_SMALL.

{
    if ( bufferLen < m_bufferLen )
        throw WOscException(ERR_BUFFER_TO_SMALL, __FILE__, __LINE__);
    memcpy(buffer, m_buffer, m_bufferLen);
}

int WOscBlob::GetBufferLen

(

)

const

Returns the buffer-length of the formatted buffer. This length includes zero-padding and size of the blob size.

Returns:

Size of the formatted buffer.

See also:

GetDataLen()

Definition at line 220 of file WOscBlob.cpp.

Referenced by WOscMessage::WOscMessage().

{
    return m_bufferLen;
}

const char * WOscBlob::GetData

(

)

const

Returns a pointer to the blob data. Get the length of the buffer with WOscBlob::GetDataLength() .

Returns:

Pointer to the buffer containing the data.

Definition at line 73 of file WOscBlob.cpp.

References BLOB_SIZE_SIZE.

{
    return m_buffer + BLOB_SIZE_SIZE;
}

int WOscBlob::GetDataLen

(

)

const

Returns the length of the data without zero-padding.

Returns:

Size without zeros.

See also:

GetBufferLen()

Definition at line 205 of file WOscBlob.cpp.

{
    return m_dataLen;
}

WOscBlob & WOscBlob::operator=

(

WOscBlob &

rhs

)

Assignment operator. Copies the content of the referenced blob into this one.

Parameters:

rhs

Reference to another blob (right hand side of operator).

Exceptions:

None.

Remarks:

None.

Definition at line 137 of file WOscBlob.cpp.

{
    if ( this != &rhs ) {
        delete [] m_buffer;
        m_dataLen = rhs.m_dataLen;
        m_bufferLen = rhs.m_bufferLen;
        m_buffer = new char[m_bufferLen];
        memcpy(m_buffer, rhs.m_buffer, m_bufferLen);
    }
    return *this;
}

---

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

• WOscBlob.h
• WOscBlob.cpp