obx::SyncObjectsMessageBuilder Class Reference

Start here to prepare an 'objects message'. You must add at least one object and then you can send the message using SyncClient::send() or SyncServer::send(). More...

#include <objectbox-sync.hpp>

Public Member Functions
	SyncObjectsMessageBuilder ()
	SyncObjectsMessageBuilder (const std::string &topic)
	SyncObjectsMessageBuilder (const void *topic, size_t topicSize)
	SyncObjectsMessageBuilder (SyncObjectsMessageBuilder &&source) noexcept
	SyncObjectsMessageBuilder (const SyncObjectsMessageBuilder &)=delete
	Can't be copied, single owner of C resources is required (to avoid double-free during destruction)
virtual	~SyncObjectsMessageBuilder ()
void	add (OBXSyncObjectType type, const void *data, size_t size, uint64_t id=0)
	Adds an object to the given message (builder).
void	add (const std::string &object, uint64_t id=0)
	Adds a string object to the given message (builder).

Detailed Description

Start here to prepare an 'objects message'. You must add at least one object and then you can send the message using SyncClient::send() or SyncServer::send().

Constructor & Destructor Documentation

SyncObjectsMessageBuilder() [1/5]

obx::SyncObjectsMessageBuilder::SyncObjectsMessageBuilder ( )

inline

SyncObjectsMessageBuilder() [2/5]

obx::SyncObjectsMessageBuilder::SyncObjectsMessageBuilder ( const std::string &  topic )

inlineexplicit

Parameters

topic

- application-specific message qualifier

SyncObjectsMessageBuilder() [3/5]

obx::SyncObjectsMessageBuilder::SyncObjectsMessageBuilder ( const void *  topic, size_t  topicSize  )

inlineexplicit

Parameters

topic

- application-specific message qualifier (may be NULL), usually a string but can also be binary

SyncObjectsMessageBuilder() [4/5]

obx::SyncObjectsMessageBuilder::SyncObjectsMessageBuilder ( SyncObjectsMessageBuilder &&  source )

inlinenoexcept

SyncObjectsMessageBuilder() [5/5]

obx::SyncObjectsMessageBuilder::SyncObjectsMessageBuilder ( const SyncObjectsMessageBuilder &  )

delete

Can't be copied, single owner of C resources is required (to avoid double-free during destruction)

~SyncObjectsMessageBuilder()

virtual obx::SyncObjectsMessageBuilder::~SyncObjectsMessageBuilder ( )

inlinevirtual

Member Function Documentation

add() [1/2]

void obx::SyncObjectsMessageBuilder::add ( const std::string &  object, uint64_t  id = 0  )

inline

Adds a string object to the given message (builder).

Parameters

id	an optional (pass 0 if you don't need it) value that the application can use identify the object

add() [2/2]

void obx::SyncObjectsMessageBuilder::add ( OBXSyncObjectType  type, const void *  data, size_t  size, uint64_t  id = 0  )

inline

Adds an object to the given message (builder).

Parameters

id	an optional (pass 0 if you don't need it) value that the application can use identify the object