cc_tools_qt Namespace Reference

Main namespace for all classes / functions of the shared library. More...

Namespaces
	property
	Namespace containing classes describing various properties.

Classes
struct	DataInfo
	Information about incomming or outdoing data. More...
class	Filter
	Main polymorphic interface class for filters. More...
class	Message
	Main interface class used by CommsChampion Tools to display and manipulate messages. More...
class	MessageBase
	Helper class used to define protocol message interface class in CommsChampion Tools plugin environment. More...
class	MessageHandler
	Generic message handler used by CommsChampion Tools. More...
class	Plugin
	Interface class for plugin definition. More...
class	PluginProperties
	Accumulation of various properties of Plugin. More...
class	Protocol
	Main polymorphic interface class for protocols. More...
class	ProtocolBase
	Helper class to define custom Protocol. More...
class	ProtocolMessageBase
	Helper class used to implement several pure virtual functions defined in cc_tools_qt::Message interface class. More...
class	RawDataMessage
	Raw data message. More...
class	Socket
	Main polymorphic interface class for sockets. More...
class	TransportMessageBase
	Base class for TransportMessage definition in protocol plugin. More...

Typedefs
using	DataInfoPtr = std::shared_ptr< DataInfo >
	Pointer to DataInfo.
using	FilterPtr = std::shared_ptr< Filter >
	Pointer to Filter object.
using	MessagePtr = std::shared_ptr< Message >
	Smart pointer to Message.
using	ProtocolPtr = std::shared_ptr< Protocol >
	Pointer to Protocol object.
using	SocketPtr = std::shared_ptr< Socket >
	Pointer to Socket object.

Enumerations
enum class	ErrorStatus {   Success , NotEnoughData , ProtocolError , BufferOverflow ,   InvalidMsgId , InvalidMsgData , MsgAllocFailure , NumOfErrorStatuses }

Functions
CC_API DataInfoPtr	makeDataInfo ()
	Dynamically allocate DataInfo and return in in DataInfoPtr;.
CC_API DataInfoPtr	makeDataInfoTimed ()
	Dynamically allocate DataInfo and return in in DataInfoPtr;. More...
constexpr unsigned	version ()
	Version of the library as single numeric value.
constexpr unsigned	versionCreate (unsigned major, unsigned minor, unsigned patch)
	Create version of the library as single unsigned numeric value.
constexpr unsigned	versionMajor ()
	Major verion of the library.
constexpr unsigned	versionMinor ()
	Minor verion of the library.
constexpr unsigned	versionPatch ()
	Patch level of the library.

Detailed Description

Main namespace for all classes / functions of the shared library.

Enumeration Type Documentation

ErrorStatus

enum cc_tools_qt::ErrorStatus

strong

Enumerator
Success	Used to indicate successful outcome of the operation.
NotEnoughData	Used to indicate that stream buffer didn't contain enough data to complete read operation.
ProtocolError	Used to indicate that any of the used protocol layers encountered an error while processing the data.
BufferOverflow	Used to indicate that stream buffer was overflowed when attempting to write data.
InvalidMsgId	Used to indicate that received message has unknown id.
InvalidMsgData	Used to indicate that received message has invalid data.
MsgAllocFailure	Used to indicate that message allocation has failed.
NumOfErrorStatuses	Number of supported error statuses, must be last.

Function Documentation

makeDataInfoTimed()

CC_API DataInfoPtr cc_tools_qt::makeDataInfoTimed

(

)

Dynamically allocate DataInfo and return in in DataInfoPtr;.

Automatically populate the timestamp.