Corelink::SendStream Class Reference

#include <CorelinkClasses.h>

Public Member Functions
	SendStream (const StreamData &streamData)
	SendStream (const SendStream &rhs)
	SendStream (SendStream &&rhs)
SendStream &	operator= (const SendStream &rhs)
	operator STREAM_ID () const
bool	send (const std::string &msg, const int &federationID=0)
bool	send (const std::string &msg, const rapidjson::Document &json, bool serverCheck=false, const int &federationID=0)
bool	send (const char *msg, int msgLen, const int &federationID=0)
bool	send (const char *msg, int msgLen, const rapidjson::Document &json, bool serverCheck=false, const int &federationID=0)

Friends
class	StreamData

Detailed Description

Definition at line 462 of file CorelinkClasses.h.

Constructor & Destructor Documentation

SendStream() [1/3]

Corelink::SendStream::SendStream ( const StreamData &  streamData )

inline

Definition at line 16 of file CorelinkSendStream.h.

SendStream() [2/3]

Corelink::SendStream::SendStream ( const SendStream &  rhs )

inline

Definition at line 29 of file CorelinkSendStream.h.

SendStream() [3/3]

Corelink::SendStream::SendStream ( SendStream &&  rhs )

inline

Definition at line 33 of file CorelinkSendStream.h.

Member Function Documentation

operator STREAM_ID()

Corelink::SendStream::operator STREAM_ID ( ) const

inline

Definition at line 46 of file CorelinkSendStream.h.

operator=()

SendStream & Corelink::SendStream::operator= ( const SendStream &  rhs )

inline

Definition at line 39 of file CorelinkSendStream.h.

send() [1/4]

bool Corelink::SendStream::send ( const std::string &  msg, const int &  federationID = 0  )

inline

Use to send data on the stream. Target functionity not implemented though it should be able to specify the reciever. Thread safe.

Parameters

msg	Data to send to server.
federationID	Server specified to recieve data.

Returns

If stream exists on client.

Definition at line 50 of file CorelinkSendStream.h.

send() [2/4]

bool Corelink::SendStream::send ( const std::string &  msg, const rapidjson::Document &  json, bool  serverCheck = false, const int &  federationID = 0  )

inline

Use to send data on the stream. Target functionity not implemented though it should be able to specify the reciever. Thread safe.

Parameters

msg	Data to send to server.
json	Json to attach with the message.
federationID	Server specified to recieve data.
serverCheck	Should server check the json.

Returns

If stream exists on client.

Definition at line 54 of file CorelinkSendStream.h.

send() [3/4]

bool Corelink::SendStream::send ( const char *  msg, int  msgLen, const int &  federationID = 0  )

inline

Use to send data on the stream. Target functionity not implemented though it should be able to specify the reciever. Thread safe.

Parameters

msg	Data to send to server.
msgLen	Length of data to send.
federationID	Server specified to recieve data.

Returns

If stream exists on client.

Definition at line 62 of file CorelinkSendStream.h.

send() [4/4]

bool Corelink::SendStream::send ( const char *  msg, int  msgLen, const rapidjson::Document &  json, bool  serverCheck = false, const int &  federationID = 0  )

inline

Use to send data on the stream. Target functionity not implemented though it should be able to specify the reciever. Thread safe.

Parameters

msg	Data to send to server.
msgLen	Length of data to send.
json	Json to attach with the message.
federationID	Server specified to recieve data.
serverCheck	Should server check the json.

Returns

If stream exists on client.

Definition at line 66 of file CorelinkSendStream.h.

Friends And Related Function Documentation

StreamData

friend class StreamData

friend

Definition at line 463 of file CorelinkClasses.h.

---

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

• clients/cpp/CorelinkClasses.h
• clients/cpp/CorelinkSendStream.h