JSONM: a JSON document with attached binary chunks in one contiguous buffer. More...

#include <NetworkProtocols.h>

Collaboration diagram for cmlabs::JSONM:

Public Member Functions
	JSONM ()
	JSONM (const char *data, uint64 size)
	Parse a complete JSONM container from raw bytes.
	JSONM (const char *json)
	Create a container from JSON text only (no attachments yet).
	~JSONM ()
uint64	getSize ()
uint32	getCount ()
bool	isValid ()
std::string	getJSON ()
const char *	getData (const char *name, uint64 &size)
	Get an attachment's bytes by name.
const char *	getData (uint32 chunk, uint64 &size)
	Get an attachment's bytes by chunk index.
std::string	getDataType (const char *name)
std::string	getDataType (uint32 chunk)
std::string	getDataName (uint32 chunk)
bool	setJSON (const char *json)
	Replace the JSON text portion (multipart metadata is regenerated).
uint32	addData (const char name, const char data, uint64 size, const char *type)
	Append a binary attachment.
std::string	getInfoString ()
DataMessage *	convertToMessage ()
	Convert this container into a binary DataMessage.

Public Attributes
char *	jmData
	Owned serialised container buffer (JSON + attachments).
uint64	jmSize
	Total size of ::jmData in bytes.
uint64	mOffset
	Byte offset where the binary multipart section begins.
std::map< uint32, JSONMEntry >	entries
	Attachment metadata by chunk index.

Detailed Description

JSONM: a JSON document with attached binary chunks in one contiguous buffer.

Wire format used to move JSON plus binary payloads (images, audio, etc.) as a single blob: the JSON text comes first and describes the attachments (name, size, MIME type); the raw binary chunks follow at recorded offsets. Construct from received bytes to parse, or build up with setJSON() + addData() to send. Internally serialised into ::jmData.

Note: Guarded by an internal mutex, so concurrent readers/writers on the same object are safe, but typical usage is single-threaded.

Definition at line 354 of file NetworkProtocols.h.

Constructor & Destructor Documentation

◆ JSONM() [1/3]

cmlabs::JSONM::JSONM ( )

Definition at line 2460 of file NetworkProtocols.cpp.

References jmData, jmSize, and mOffset.

◆ JSONM() [2/3]

cmlabs::JSONM::JSONM	(	const char *	data,
		uint64	size )

Parse a complete JSONM container from raw bytes.

Parameters

data	Container bytes (copied).
size	Total size in bytes.

Definition at line 2465 of file NetworkProtocols.cpp.

References jmData, jmSize, and mOffset.

◆ JSONM() [3/3]

cmlabs::JSONM::JSONM ( const char * json )

Create a container from JSON text only (no attachments yet).

Parameters

json	NUL-terminated JSON text (copied).

Definition at line 2477 of file NetworkProtocols.cpp.

References jmData, jmSize, and setJSON().

◆ ~JSONM()

cmlabs::JSONM::~JSONM ( )

Definition at line 2486 of file NetworkProtocols.cpp.

References jmData, jmSize, and mOffset.

Member Function Documentation

◆ addData()

uint32 cmlabs::JSONM::addData	(	const char *	name,
		const char *	data,
		uint64	size,
		const char *	type )

Append a binary attachment.

Parameters

name	Attachment name.
data	Bytes (copied).
size	Byte count.
type	MIME type.

Returns: The new chunk index, or 0 on failure.

Definition at line 2675 of file NetworkProtocols.cpp.

References cmlabs::JSONMEntry::chunk, entries, getCount(), getData(), jmData, jmSize, cmlabs::JSONMEntry::name, cmlabs::JSONMEntry::offset, setJSON(), cmlabs::JSONMEntry::size, and cmlabs::JSONMEntry::type.

Referenced by cmlabs::RequestGateway::replyToClient(), and cmlabs::TestWebSocketRequestClient::run().

◆ convertToMessage()

DataMessage * cmlabs::JSONM::convertToMessage ( )

Convert this container into a binary DataMessage.

Returns: A new DataMessage owned by the caller, or NULL.

Definition at line 2830 of file NetworkProtocols.cpp.

References entries, getJSON(), cmlabs::GetTimeNow(), jmData, mOffset, cmlabs::DataMessage::setCreatedTime(), cmlabs::DataMessage::setData(), cmlabs::DataMessage::setRecvTime(), and cmlabs::DataMessage::setString().

Referenced by cmlabs::RequestGateway::receiveWebsocketData().

◆ getCount()

uint32 cmlabs::JSONM::getCount ( )

Returns: Number of binary attachment chunks.

Definition at line 2501 of file NetworkProtocols.cpp.

References entries.

Referenced by addData(), and getInfoString().

◆ getData() [1/2]

const char * cmlabs::JSONM::getData	(	const char *	name,
		uint64 &	size )

Get an attachment's bytes by name.

Parameters

name	Attachment name.
size	Out: attachment size.

Returns: Pointer into the internal buffer (valid while this object lives), or NULL.

Definition at line 2538 of file NetworkProtocols.cpp.

References entries, jmData, jmSize, LOG_NETWORK, LogPrint, mOffset, and stricmp.

Referenced by addData().

◆ getData() [2/2]

const char * cmlabs::JSONM::getData	(	uint32	chunk,
		uint64 &	size )

Get an attachment's bytes by chunk index.

Parameters

chunk	Chunk index.
size	Out: attachment size.

Returns: Pointer into the internal buffer, or NULL.

Definition at line 2616 of file NetworkProtocols.cpp.

References entries, jmData, jmSize, LOG_NETWORK, LogPrint, and mOffset.

◆ getDataName()

std::string cmlabs::JSONM::getDataName ( uint32 chunk )

Parameters

chunk Chunk index.

Returns: Its attachment name, or empty.

Definition at line 2597 of file NetworkProtocols.cpp.

References entries, jmData, and jmSize.

◆ getDataType() [1/2]

std::string cmlabs::JSONM::getDataType ( const char * name )

Parameters

name	Attachment name.

Returns: Its MIME type, or empty.

Definition at line 2564 of file NetworkProtocols.cpp.

References entries, jmData, jmSize, and stricmp.

◆ getDataType() [2/2]

std::string cmlabs::JSONM::getDataType ( uint32 chunk )

Parameters

chunk Chunk index.

Returns: Its MIME type, or empty.

Definition at line 2582 of file NetworkProtocols.cpp.

References entries, jmData, and jmSize.

◆ getInfoString()

std::string cmlabs::JSONM::getInfoString ( )

Returns: Multi-line human-readable summary of all chunks.

Definition at line 2704 of file NetworkProtocols.cpp.

References cmlabs::utils::BytifySize(), entries, getCount(), jmData, jmSize, mOffset, and cmlabs::utils::StringFormat().

◆ getJSON()

std::string cmlabs::JSONM::getJSON ( )

Returns: The JSON text portion of the container.

Definition at line 2528 of file NetworkProtocols.cpp.

References jmData, jmSize, and cmlabs::utils::laststrstr().

Referenced by convertToMessage(), and cmlabs::RequestGateway::receiveWebsocketData().

◆ getSize()

uint64 cmlabs::JSONM::getSize ( )

Returns: Total serialised size (JSON plus all attachments) in bytes.

Definition at line 2495 of file NetworkProtocols.cpp.

References jmSize.

Referenced by cmlabs::TestWebSocketRequestClient::run().

◆ isValid()

bool cmlabs::JSONM::isValid ( )

Returns: true when the container holds parseable JSON and consistent chunk metadata.

Definition at line 2508 of file NetworkProtocols.cpp.

References entries, jmData, jmSize, cmlabs::utils::laststrstr(), LOG_NETWORK, and LogPrint.

Referenced by cmlabs::RequestGateway::receiveWebsocketData(), and cmlabs::TestWebSocketRequestClient::run().

◆ setJSON()

bool cmlabs::JSONM::setJSON ( const char * json )

Replace the JSON text portion (multipart metadata is regenerated).

Parameters

json	NUL-terminated JSON text.

Returns: true on success.

Definition at line 2665 of file NetworkProtocols.cpp.

Referenced by addData(), JSONM(), cmlabs::RequestGateway::replyToClient(), and cmlabs::TestWebSocketRequestClient::run().

Member Data Documentation

◆ entries

std::map<uint32, JSONMEntry> cmlabs::JSONM::entries

Attachment metadata by chunk index.

Definition at line 406 of file NetworkProtocols.h.

Referenced by addData(), convertToMessage(), getCount(), getData(), getData(), getDataName(), getDataType(), getDataType(), getInfoString(), isValid(), and cmlabs::RequestGateway::receiveWebsocketData().

◆ jmData

char* cmlabs::JSONM::jmData

Owned serialised container buffer (JSON + attachments).

Definition at line 403 of file NetworkProtocols.h.

Referenced by addData(), convertToMessage(), getData(), getData(), getDataName(), getDataType(), getDataType(), getInfoString(), getJSON(), isValid(), JSONM(), JSONM(), JSONM(), cmlabs::RequestGateway::replyToClient(), cmlabs::TestWebSocketRequestClient::run(), and ~JSONM().

◆ jmSize

uint64 cmlabs::JSONM::jmSize

Total size of ::jmData in bytes.

Definition at line 404 of file NetworkProtocols.h.

Referenced by addData(), getData(), getData(), getDataName(), getDataType(), getDataType(), getInfoString(), getJSON(), getSize(), isValid(), JSONM(), JSONM(), JSONM(), cmlabs::RequestGateway::receiveWebsocketData(), cmlabs::RequestGateway::replyToClient(), and ~JSONM().

◆ mOffset

uint64 cmlabs::JSONM::mOffset

Byte offset where the binary multipart section begins.

Definition at line 405 of file NetworkProtocols.h.

Referenced by convertToMessage(), getData(), getData(), getInfoString(), JSONM(), JSONM(), and ~JSONM().

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

/home/ubuntu/c/partner/psyclone2/CMSDK/include/NetworkProtocols.h
/home/ubuntu/c/partner/psyclone2/CMSDK/src/NetworkProtocols.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JSONM() [1/3]

◆ JSONM() [2/3]

◆ JSONM() [3/3]

◆ ~JSONM()

Member Function Documentation

◆ addData()

◆ convertToMessage()

◆ getCount()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDataName()

◆ getDataType() [1/2]

◆ getDataType() [2/2]

◆ getInfoString()

◆ getJSON()

◆ getSize()

◆ isValid()

◆ setJSON()

Member Data Documentation

◆ entries

◆ jmData

◆ jmSize

◆ mOffset