#include <CeylanProtocolEndpoint.h>
Public Types | |
enum | TextOutputFormat { rawText, html } |
Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
ProtocolEndpoint (Marshaller &marshaller) | |
Constructs a new protocol endpoint. | |
virtual | ~ProtocolEndpoint () throw () |
Virtual destructor. | |
virtual const std::string | toString (Ceylan::VerbosityLevels level=Ceylan::high) const |
Returns a user-friendly description of the state of this object. | |
Static Public Member Functions | |
static const std::string | ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high) |
Returns a user-friendly description of this list of pointers to text displayable instances. | |
static TextOutputFormat | GetOutputFormat () |
Returns the current overall text format to be used by TextDisplayable instances. | |
static void | SetOutputFormat (TextOutputFormat newOutputFormat) |
Sets the current overall text format to be used by TextDisplayable instances. | |
Protected Attributes | |
Marshaller * | _marshaller |
The marshaller that will be used to (de)serialize informations of this endpoint. | |
Static Protected Attributes | |
static TextOutputFormat | _OutputFormat = rawText |
The text format to be used currently by TextDisplayable instances. | |
Private Member Functions | |
ProtocolEndpoint (const ProtocolEndpoint &source) | |
Copy constructor made private to ensure that it will be never called. | |
ProtocolEndpoint & | operator= (const ProtocolEndpoint &source) |
Assignment operator made private to ensure that it will be never called. |
A protocol endpoint is built on top of an InputOutputStream, this stream being most often a network one, or a pipe one.
A protocol needs a Marshaller object to read and write informations from and to the stream.
Definition at line 90 of file CeylanProtocolEndpoint.h.
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
ProtocolEndpoint::ProtocolEndpoint | ( | Marshaller & | marshaller | ) |
Constructs a new protocol endpoint.
marshaller | a marshaller that will encode and/or decode data to/from the stream it encapsulates, on the behalf of this protocol endpoint so that the actual protocol-driven informations are properly serialized. |
Definition at line 60 of file CeylanProtocolEndpoint.cc.
ProtocolEndpoint::~ProtocolEndpoint | ( | ) | throw () [virtual] |
Virtual destructor.
Definition at line 69 of file CeylanProtocolEndpoint.cc.
References _marshaller.
Ceylan::Middleware::ProtocolEndpoint::ProtocolEndpoint | ( | const ProtocolEndpoint & | source | ) | [private] |
Copy constructor made private to ensure that it will be never called.
The compiler should complain whenever this undefined constructor is called, implicitly or not.
TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat | ( | ) | [static, inherited] |
Returns the current overall text format to be used by TextDisplayable instances.
Definition at line 63 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().
ProtocolEndpoint& Ceylan::Middleware::ProtocolEndpoint::operator= | ( | const ProtocolEndpoint & | source | ) | [private] |
Assignment operator made private to ensure that it will be never called.
The compiler should complain whenever this undefined operator is called, implicitly or not.
void TextDisplayable::SetOutputFormat | ( | TextOutputFormat | newOutputFormat | ) | [static, inherited] |
Sets the current overall text format to be used by TextDisplayable instances.
newOutputFormat | the new output format. |
Definition at line 72 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::Log::LogHolder::LogHolder().
const std::string TextDisplayable::ToString | ( | std::list< TextDisplayable * > | displayables, | |
Ceylan::VerbosityLevels | level = Ceylan::high | |||
) | [static, inherited] |
Returns a user-friendly description of this list of pointers to text displayable instances.
displayables | a list of pointers to TextDisplayable instances/ | |
level | the requested verbosity level. |
Definition at line 45 of file CeylanTextDisplayable.cc.
References Ceylan::formatStringList().
const string ProtocolEndpoint::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [virtual] |
Returns a user-friendly description of the state of this object.
level | the requested verbosity level. |
Implements Ceylan::TextDisplayable.
Reimplemented in Ceylan::Middleware::ProtocolServer.
Definition at line 78 of file CeylanProtocolEndpoint.cc.
References _marshaller, Ceylan::low, and Ceylan::Middleware::Marshaller::toString().
The marshaller that will be used to (de)serialize informations of this endpoint.
Definition at line 146 of file CeylanProtocolEndpoint.h.
Referenced by toString(), and ~ProtocolEndpoint().
TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited] |
The text format to be used currently by TextDisplayable instances.
Definition at line 158 of file CeylanTextDisplayable.h.
Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().