AOSharedServiceLibrary
Public Member Functions | List of all members
AOSSL::MongoBufferInterface Class Referenceabstract

A Structure for holding a BSON Document. More...

#include <mongo_buffer_interface.h>

Public Member Functions

virtual bool successful ()=0
 Is a successful response.
 
virtual std::string get_error_message ()=0
 Error message.
 
virtual bson_t * get_bson ()=0
 Get the underlying bson_t document to pass to the mongoc driver.
 
virtual void add_oid (std::string value)=0
 Add an OID value to the buffer.
 
virtual void get_oid (std::string key, std::string &value)=0
 Get an OID value from the buffer.
 
virtual void add_string (std::string key, std::string value)=0
 Add a string value to the buffer.
 
virtual void add_string (std::string value, int encoding)=0
 Add a string value to the open array in the buffer.
 
virtual void add_string (std::string value)=0
 Add a string value to the open array in the buffer.
 
virtual void add_string (std::string key, std::string value, int encoding)=0
 Add a string value to the buffer.
 
virtual void get_string (std::string key, std::string &value)=0
 Get a string value from the buffer.
 
virtual void add_bool (std::string key, bool value)=0
 Add a boolean value to the buffer.
 
virtual void add_bool (bool value)=0
 Add a boolean value to the open array in the buffer.
 
virtual bool get_bool (std::string key)=0
 Get a boolean value from the buffer.
 
virtual void add_int (std::string key, int value)=0
 Add an integer value to the buffer.
 
virtual void add_int (int value)=0
 Add an integer value to the open array in the buffer.
 
virtual int get_int (std::string key)=0
 Get an integer value from the buffer.
 
virtual void add_double (std::string key, double value)=0
 Add a double value to the buffer.
 
virtual void add_double (double value)=0
 Add a double value to the open array in the buffer.
 
virtual double get_double (std::string key)=0
 Get a double value from the buffer.
 
virtual void add_date (std::string key, int value)=0
 Add a datetime value to the buffer.
 
virtual void add_date (int value)=0
 Add an datetime value to the open array in the buffer.
 
virtual int get_date (std::string key)=0
 Get a date value from the buffer.
 
virtual void start_array (std::string key)=0
 Start an array in the buffer.
 
virtual void end_array ()=0
 End an array value in the buffer.
 
virtual void start_object (std::string key)=0
 Start a subdocument in the buffer.
 
virtual void end_object ()=0
 End a subdocument in the buffer.
 
virtual int count_keys ()=0
 Count the number of keys in the BSON Document.
 
virtual bool has_field (std::string key)=0
 Is a specific key present in the BSON Document.
 
virtual std::string to_json ()=0
 Convert the BSON Buffer to a JSON Document and store internally in the Mongo Buffer. More...
 
virtual std::string to_json (int string_length)=0
 Convert the BSON Buffer to a JSON Document and store internally in the Mongo Buffer. More...
 

Detailed Description

A Structure for holding a BSON Document.

Writing and reading from the buffer MUST be done independently In other words, once you start reading, you cannot do any more writing. Also, reads must happen on the document in order

Member Function Documentation

virtual std::string AOSSL::MongoBufferInterface::to_json ( )
pure virtual

Convert the BSON Buffer to a JSON Document and store internally in the Mongo Buffer.

Note that the converted message will be retained in memory until the Mongo Buffer is destroyed. Not thread-safe

virtual std::string AOSSL::MongoBufferInterface::to_json ( int  string_length)
pure virtual

Convert the BSON Buffer to a JSON Document and store internally in the Mongo Buffer.

Note that the converted message will be retained in memory until the Mongo Buffer is destroyed. Not thread-safe


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