Linux Manuals session 3

Atlas::Objects::Entity::RootEntityData – Starting point for entity hierarchy. Synopsis#include <RootEntity.h> Inherits Atlas::Objects::RootData. Inherited by Atlas::Objects::Entity::AdminEntityData, Atlas::Objects::Entity::AnonymousData, and Atlas::Objects::Entity::GameEntityData. Public Member Functionsvirtual RootEntityData * 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::Entity::PlayerData – Player accounts. Synopsis#include <Entity.h> Inherits Atlas::Objects::Entity::AccountData. Public Member Functionsvirtual PlayerData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate over the attributes of this instance. virtual void free () Free an instance of this…

Atlas::Objects::Entity::GameEntityData – All In Game classes and objects. Synopsis#include <Entity.h> Inherits Atlas::Objects::Entity::RootEntityData. Public Member Functionsvirtual GameEntityData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate over the attributes of this instance. virtual void free () Free…

Atlas::Objects::Entity::GameData – Games this server hosts. Synopsis#include <Entity.h> Inherits Atlas::Objects::Entity::AdminEntityData. Public Member Functionsvirtual GameData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate over the attributes of this instance. virtual void free () Free an instance…

Atlas::Objects::Entity::AnonymousData – Starting point for entity hierarchy. Synopsis#include <Anonymous.h> Inherits Atlas::Objects::Entity::RootEntityData. Public Member Functionsvoid setType (const std::string &, int) Set the type of this object. virtual AnonymousData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate…

Atlas::Objects::Entity::AdminEntityData – All classes and objects used for adminitrativive purposes. Synopsis#include <Entity.h> Inherits Atlas::Objects::Entity::RootEntityData. Inherited by Atlas::Objects::Entity::AccountData, and Atlas::Objects::Entity::GameData. Public Member Functionsvirtual AdminEntityData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate over the attributes of…

Atlas::Objects::Entity::AdminData – Privileged accounts. Synopsis#include <Entity.h> Inherits Atlas::Objects::Entity::AccountData. Public Member Functionsvirtual AdminData * copy () const Copy this object. virtual bool instanceOf (int classNo) const Is this instance of some class? virtual void iterate (int &current_class, std::string &attr) const Iterate over the attributes of this instance. virtual void free () Free an instance of this…

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 Functionsvirtual 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 setAttr (const…

Atlas::Objects::Dispatcher – Objects hierarchy dispatcher. Synopsis#include <Dispatcher.h> Inherits Atlas::Objects::ObjectsDecoder. Public Member Functionsvirtual ~Dispatcher () Default destructor. void addMethod (int, objectArrivedPtr method) Add a new method for Objects class defined by application. Protected Member Functionsvirtual void unknownObjectArrived (const Root &) An unknown object has arrived. virtual void objectArrived (const Root &) An object has arrived for…

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> Classesclass PsuedoElement Public Typestypedef std::pair< std::string, PsuedoElement > value_type Public Member Functionsiterator (const iterator &I) iterator (BaseObjectData &obj, int current_class) iterator & operator= (const iterator &I) iterator & operator++ () iterator operator++ (int)…

Atlas::Objects::BaseObjectData – Atlas base object class. Synopsis#include <BaseObject.h> Inherited by Atlas::Objects::RootData. Classesclass 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 FunctionsBaseObjectData (BaseObjectData *defaults) Construct a new BaseObjectData from a subclass. int getClassNo () const Get class number:. int getAttrFlags ()…

Atlas::Objects – The Atlas high level Objects namespace. SynopsisClassesclass 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. class NullSmartPtrDereference…

Atlas::Net::StreamConnect – Negotiation of clients building a connection to a remote system. Synopsis#include <Stream.h> Inherits Atlas::Negotiate. Public Member FunctionsStreamConnect (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 clients building a connection to a remote system. Used once a stream connection…

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…