Section 3: library functions
Atlas::Objects::Entity::AdminData – Privileged accounts. Synopsis #include <Entity.h> Inherits Atlas::Objects::Entity::AccountData. Public Member Functions virtual AdminData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int ¤t_class, std::string &attr) const Iterate over the attributes of this instance. virtual void free () Free an instance…
Atlas::Objects::Entity::AccountData – Base class for accounts. Synopsis #include <Entity.h> Inherits Atlas::Objects::Entity::AdminEntityData. Inherited by Atlas::Objects::Entity::AdminData, and Atlas::Objects::Entity::PlayerData. Public Member Functions virtual AccountData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual int copyAttr (const std::string &name, Atlas::Message::Element &attr) const Retrieve the attribute ‘name’. virtual void…
Atlas::Objects::Dispatcher – Objects hierarchy dispatcher. Synopsis #include <Dispatcher.h> Inherits Atlas::Objects::ObjectsDecoder. Public Member Functions virtual ~Dispatcher () Default destructor. void addMethod (int, objectArrivedPtr method) Add a new method for Objects class defined by application. Protected Member Functions virtual void unknownObjectArrived (const Root &) An unknown object has arrived. virtual void objectArrived (const Root &) An object…
Atlas::Objects::BaseObjectData::iterator – The iterator first iterates over the contents of m_obj->m_attributes, holding an iterator to the attributes map in m_I. Synopsis #include <BaseObject.h> Classes class PsuedoElement Public Types typedef std::pair< std::string, PsuedoElement > value_type Public Member Functions iterator (const iterator &I) iterator (BaseObjectData &obj, int current_class) iterator & operator= (const iterator &I) iterator & operator++…
Atlas::Objects::BaseObjectData – Atlas base object class. Synopsis #include <BaseObject.h> Inherited by Atlas::Objects::RootData. Classes class const_iterator class iterator The iterator first iterates over the contents of m_obj->m_attributes, holding an iterator to the attributes map in m_I. Public Member Functions BaseObjectData (BaseObjectData *defaults) Construct a new BaseObjectData from a subclass. int getClassNo () const Get class number:….
Atlas::Objects – The Atlas high level Objects namespace. Synopsis Classes class NoSuchAttrException An exception indicating the requested attribute does not exist. class BaseObjectData Atlas base object class. class ObjectsDecoder Objects hierarchy decoder. class Dispatcher Objects hierarchy dispatcher. class ObjectsEncoder Objects hierarchy encoder. class DefaultLoadingException class NoSuchFactoryException class Factories class RootData All objects inherit from this….
Atlas::Net::StreamConnect – Negotiation of clients building a connection to a remote system. Synopsis #include <Stream.h> Inherits Atlas::Negotiate. Public Member Functions StreamConnect (const std::string &name, std::iostream &) virtual void poll (bool can_read=true) virtual State getState () virtual Atlas::Codec * getCodec (Atlas::Bridge &) Detailed Description Negotiation of clients building a connection to a remote system. Used once…
Atlas::Net::StreamAccept – Negotiation of servers accepting a connection from a remote system. Synopsis #include <Stream.h> Inherits Atlas::Negotiate. Public Member Functions StreamAccept (const std::string &name, std::iostream &) virtual void poll (bool can_read=true) virtual State getState () virtual Atlas::Codec * getCodec (Atlas::Bridge &) Detailed Description Negotiation of servers accepting a connection from a remote system. Used once…
Atlas::Net::NegotiateHelper – Negotiation of codecs and filters for an Atlas connection. Synopsis #include <Stream.h> Public Member Functions NegotiateHelper (std::list< std::string > &names) bool get (std::string &buf, const std::string &header) void put (std::string &buf, const std::string &header) Detailed Description Negotiation of codecs and filters for an Atlas connection. non blocking negotiation of Codecs and Filters requires…
Atlas::Net – The Atlas network communication namespace. Synopsis Classes class 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. Functions void loopback (Bridge *, Bridge *, Bridge *&, Bridge *&)…
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 Types enum State { IN_PROGRESS, SUCCEEDED, FAILED } Public Member Functions virtual State getState ()=0 virtual Codec * getCodec (Bridge &)=0 virtual void poll (bool can_get=true)=0 Detailed Description Negotiation of codecs and filters for an…
Atlas::Message::QueuedDecoder – Decoder that presents a queue of Atlas::Message::Element. Synopsis #include <QueuedDecoder.h> Inherits Atlas::Message::DecoderBase. Public Member Functions size_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…
Atlas::Message::Encoder – Encoder that transmits Atlas::Message::Element. Synopsis #include <MEncoder.h> Inherits Atlas::EncoderBase. Public Member Functions Encoder (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 &)…
Atlas::Message::Element – Multi-type container. Synopsis #include <Element.h> Classes class DataType Public Types enum Type { TYPE_NONE, TYPE_INT, TYPE_FLOAT, TYPE_PTR, TYPE_STRING, TYPE_MAP, TYPE_LIST } Public Member Functions Element () 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…
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 Functions 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)…
Atlas::Funky::Tokens – Tokens representing beginnings and ends of maps/lists. Synopsis #include <FEncoder.h> Static Public Attributes static BeginMap begin_map static EndMap end_map static BeginList begin_list static EndList end_list Detailed Description Tokens representing beginnings and ends of maps/lists. Use these as parameters to operator<< for the Funky::Encoder classes. See also: Atlas Funky Encoder Author Generated automatically by…
Atlas::Funky::FunkyEncoder – The root encoder in ‘stream’ state. Synopsis #include <FEncoder.h> Public Member Functions FunkyEncoder (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 Attributes B…
Atlas::Funky::EncMapValue – Encoder in map value state. Synopsis #include <FEncoder.h> Public Member Functions EncMapValue (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…
Atlas::Funky::EncMap – Encoder in Map state. Synopsis #include <FEncoder.h> Public Member Functions EncMap (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 Attributes B & b The bridge or encoder that is written to. Detailed Description template<class B,…
Atlas::Funky::EncList – Encoder in List state. Synopsis #include <FEncoder.h> Public Member Functions EncList (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<…