Linux Manuals session 3

Atlas::Net::StreamAccept – Negotiation of servers accepting a connection from a remote system. Synopsis#include <Stream.h> Inherits Atlas::Negotiate. Public Member FunctionsStreamAccept (const std::string &name, std::iostream &) virtual void poll (bool can_read=true) virtual State getState () virtual Atlas::Codec * getCodec (Atlas::Bridge &) Detailed DescriptionNegotiation of servers accepting a connection from a remote system. Used once a stream connection…

Atlas::Net::NegotiateHelper – Negotiation of codecs and filters for an Atlas connection. Synopsis#include <Stream.h> Public Member FunctionsNegotiateHelper (std::list< std::string > &names) bool get (std::string &buf, const std::string &header) void put (std::string &buf, const std::string &header) Detailed DescriptionNegotiation of codecs and filters for an Atlas connection. non blocking negotiation of Codecs and Filters requires a list of…

Atlas::Net – The Atlas network communication namespace. SynopsisClassesclass NegotiateHelper Negotiation of codecs and filters for an Atlas connection. class StreamConnect Negotiation of clients building a connection to a remote system. class StreamAccept Negotiation of servers accepting a connection from a remote system. Functionsvoid loopback (Bridge *, Bridge *, Bridge *&, Bridge *&) Detailed DescriptionThe Atlas…

Atlas::Negotiate – Negotiation of codecs and filters for an Atlas connection. Synopsis#include <Negotiate.h> Inherited by Atlas::Net::StreamAccept, and Atlas::Net::StreamConnect. Public Typesenum State { IN_PROGRESS, SUCCEEDED, FAILED } Public Member Functionsvirtual State getState ()=0 virtual Codec * getCodec (Bridge &)=0 virtual void poll (bool can_get=true)=0 Detailed DescriptionNegotiation of codecs and filters for an Atlas connection. non blocking…

Atlas::Message::QueuedDecoder – Decoder that presents a queue of Atlas::Message::Element. Synopsis#include <QueuedDecoder.h> Inherits Atlas::Message::DecoderBase. Public Member Functionssize_t queueSize () Retrieve the current size of the message queue. const MapType popMessage () Pop an object from the front of the message queue. const MapType frontMessage () Peek at the object at the front of the queue. void…

Atlas::Message::Encoder – Encoder that transmits Atlas::Message::Element. Synopsis#include <MEncoder.h> Inherits Atlas::EncoderBase. Public Member FunctionsEncoder (Atlas::Bridge &) void streamMessageElement (const MapType &obj) Send a message (must be a map!) in stream state. void mapElementItem (const std::string &, const Element &) Send an object as a map item. void mapElementMapItem (const std::string &, const MapType &) void mapElementListItem…

Atlas::Message::Element – Multi-type container. Synopsis#include <Element.h> Classesclass DataType Public Typesenum Type { TYPE_NONE, TYPE_INT, TYPE_FLOAT, TYPE_PTR, TYPE_STRING, TYPE_MAP, TYPE_LIST } Public Member FunctionsElement () Construct an empty object. Element (const Element &obj) Copy an existing object. Element (int v) Set type to int, and value to v. Element (bool v) Set type to int, and…

Atlas::Message::DecoderBase – Base class for decoders that take Atlas::Message::Object. Synopsis#include <DecoderBase.h> Inherits Atlas::Bridge. Inherited by Atlas::Message::QueuedDecoder, and Atlas::Objects::ObjectsDecoder. Public Member Functionsvirtual void streamBegin () Begin an Atlas stream. virtual void streamMessage () Start a message in an Atlas stream. virtual void streamEnd () Ends the Atlas stream. virtual void mapMapItem (const std::string &name) Starts a…

Atlas::Funky::Tokens – Tokens representing beginnings and ends of maps/lists. Synopsis#include <FEncoder.h> Static Public Attributesstatic BeginMap begin_map static EndMap end_map static BeginList begin_list static EndList end_list Detailed DescriptionTokens representing beginnings and ends of maps/lists. Use these as parameters to operator<< for the Funky::Encoder classes. See also: Atlas Funky EncoderAuthorGenerated automatically by Doxygen for Atlas-C++ from the…

Atlas::Funky::FunkyEncoder – The root encoder in ‘stream’ state. Synopsis#include <FEncoder.h> Public Member FunctionsFunkyEncoder (B &b) EncMap< B, FunkyEncoder > operator<< (const BeginMap &) Start a message (as a map). template<typename Arg > FunkyEncoder< B > operator<< (const Arg &a) If the encoder supports it, send a different kind of message. Protected AttributesB & b The…

Atlas::Funky::EncMapValue – Encoder in map value state. Synopsis#include <FEncoder.h> Public Member FunctionsEncMapValue (B &b, const std::string &name) EncMap< B, T > operator<< (const BeginMap &) Begin a map. EncList< B, T > operator<< (const BeginList &) Begin a list. T operator<< (long i) Send an integer value. T operator<< (double d) Send a double value….

Atlas::Funky::EncMap – Encoder in Map state. Synopsis#include <FEncoder.h> Public Member FunctionsEncMap (B &b) EncMapValue< B, EncMap< B, T > > operator<< (const std::string &name) Start a value with its name. T operator<< (EndMap) End this map. Protected AttributesB & b The bridge or encoder that is written to. Detailed Descriptiontemplate<class B, class T> class Atlas::Funky::EncMap<…

Atlas::Funky::EncList – Encoder in List state. Synopsis#include <FEncoder.h> Public Member FunctionsEncList (B &b) EncMap< B, EncList< B, T > > operator<< (const BeginMap &) Start a map. EncList< B, EncList< B, T > > operator<< (const BeginList &) Start a list. EncList< B, T > operator<< (long i) Send an integer value. EncList< B, T…

Atlas::Formatter – Atlas stream formatter. Synopsis#include <Formatter.h> Inherits Atlas::Bridge. Public Member FunctionsFormatter (std::iostream &s, Atlas::Bridge &b) virtual void streamBegin () Begin an Atlas stream. virtual void streamMessage () Start a message in an Atlas stream. virtual void streamEnd () Ends the Atlas stream. virtual void mapMapItem (const std::string &name) Starts a map object to the…

Atlas::Filter – Atlas stream filter. Synopsis#include <Filter.h> Inherited by Atlas::Filters::Bzip2, and Atlas::Filters::Gzip. Public Typesenum Type { CHECKSUM, COMPRESSION, ENCRYPTION } Public Member FunctionsFilter (Filter *=0) virtual void begin ()=0 virtual void end ()=0 virtual std::string encode (const std::string &)=0 virtual std::string decode (const std::string &)=0 Protected AttributesFilter * m_next Detailed DescriptionAtlas stream filter. Filters are…

Atlas::Exception – Base class for all exceptions thrown by Atlas-C++. Synopsis#include <Exception.h> Inherited by Atlas::Message::WrongTypeException, Atlas::Objects::DefaultLoadingException, Atlas::Objects::NoSuchAttrException, Atlas::Objects::NoSuchFactoryException, and Atlas::Objects::NullSmartPtrDereference. Public Member FunctionsException (const std::string &d=’UNKNOWN ERROR’) const std::string & getDescription () const virtual const char * what () const throw () Protected Attributesstd::string m_description Detailed DescriptionBase class for all exceptions thrown by Atlas-C++. All…

Atlas::EncoderBase – Base class forwarding to Atlas::Bridge as skeleton for other encoders. Synopsis#include <EncoderBase.h> Inherited by Atlas::Message::Encoder, and Atlas::Objects::ObjectsEncoder. Public Member FunctionsEncoderBase (Atlas::Bridge &b) You will need to implement this in subclasses. void streamBegin () void streamMessage () void streamEnd () void mapMapItem (const std::string &name) void mapListItem (const std::string &name) void mapIntItem (const std::string…

Atlas::Codec – Atlas stream codec. Synopsis#include <Codec.h> Inherits Atlas::Bridge. Inherited by Atlas::Codecs::Bach, Atlas::Codecs::Packed, and Atlas::Codecs::XML. Public Member Functionsvirtual void poll (bool can_get=true)=0 Detailed DescriptionAtlas stream codec. This class presents an interface for sending and receiving Atlas messages. Each outgoing message is converted to a byte stream and piped through an optional chain of filters for…

Atlas::Bridge – Atlas stream bridge. Synopsis#include <Bridge.h> Inherited by Atlas::Codec, Atlas::Formatter, Atlas::Message::DecoderBase, DebugBridge, and DebugBridge. Public Member Functionsvirtual void streamBegin ()=0 Begin an Atlas stream. virtual void streamMessage ()=0 Start a message in an Atlas stream. virtual void streamEnd ()=0 Ends the Atlas stream. virtual void mapMapItem (const std::string &name)=0 Starts a map object to…

Atlas – The Atlas namespace. SynopsisNamespacesnamespace Net The Atlas network communication namespace. namespace Objects The Atlas high level Objects namespace. Classesclass Bridge Atlas stream bridge. class Codec Atlas stream codec. class EncoderBase Base class forwarding to Atlas::Bridge as skeleton for other encoders. class Exception Base class for all exceptions thrown by Atlas-C++. class Filter Atlas…