Module symple

Summary

namespace scy::smpl

Summary

class scy::smpl::Client

class scy::smpl::Client
  : public scy::sockio::Client

Summary

Members

publicSignal< const int & > Announce

SignalsNotifies the outside application about the response status code of our announce() call. Possible status codes are: // - 200: Authentication success

• 401: Authentication failed

• 400: Bad request data

• 500: Server not found

public`Signal< Peer`& > PeerConnected

Signals when a peer connects.

public`Signal< Peer`& > PeerDisconnected

Signals when a peer disconnects.

public`Signal< Peer`& > CreatePresence

Called by createPresence() so outside classes can modify the outgoing Peer JSON object.

public Client(const net::Socket::Ptr & socket,constOptions& options)

public virtual ~Client()

public virtual void connect()

virtual void connect(const std::string& host, std::uint16_t port);

public virtual void close()

public virtual int send(Message& message,bool ack)

Send a message. May be a polymorphic Command, Presence, Event or other ...

public virtual int send(const std::string & message,bool ack)

Send a string message. The message must be a valid Symple message otherwise it will not be delivered.

publicsockio::Transaction* createTransaction(Message& message)

Create a Transaction object with the given message which will notify on Ack response from the server.

public virtual int respond(Message& message,bool ack)

Swap the 'to' and 'from' fields and send the given message.

public virtual int sendPresence(bool probe)

Broadcast presence to the user group scope. The outgoing Presence object may be modified via the CreatePresence signal.

public virtual int sendPresence(constAddress& to,bool probe)

Send directed presence to the given peer.

public virtual int joinRoom(const std::string & room)

Join the given room.

public virtual int leaveRoom(const std::string & room)

Leave the given room.

public virtual std::string ourID() const

Return the session ID of our current peer object. Return an empty string when offline.

public StringVec rooms() const

Return a list of rooms the client has joined.

public virtualPeer* ourPeer()

Return the peer object for the current session, or throws an exception when offline.

public virtualRoster& roster()

Return the roster which stores all online peers.

public virtualPersistenceT& persistence()

Return the persistence manager which stores long lived messages.

publicClient::Options& options()

Return a reference to the client options object.

public virtualClient& operator>>(Message& message)

Stream operator alias for send().

public virtual void onPresenceData(const json::Value & data,bool whiny)

Update the roster from the given client object.

protectedRoster_roster

protected std::string _ourID

protectedPersistenceT_persistence

protectedClient::Options_options

protected StringVec _rooms

protected int _announceStatus

protected virtual int announce()

Called when a new connection is established to announce and authenticate the peer on the server.

protected virtual void reset()

Resets variables and data at the beginning and end of each session.

protected virtual void createPresence(Presence& p)

Creates a Presence object.

protected virtual void emit(void * sender,IPacket& packet)

Override PacketSignal::emit.

protected virtual void onOnline()

protected virtual void onAnnounceState(void * sender,TransactionState& state,constTransactionState&)

class scy::smpl::Command

class scy::smpl::Command
  : public scy::smpl::Message

Summary

Members

public Command()

public Command(const json::Value & root)

public Command(constCommand& root)

public virtual ~Command()

public std::string node() const

public std::string action() const

public void setNode(const std::string & node)

public void setAction(const std::string & action)

public virtual bool valid() const

public std::string param(int n) const

public std::vector< std::string > params()

public bool matches(const std::string & xnode) const

class scy::smpl::Event

class scy::smpl::Event
  : public scy::smpl::Message

Summary

Members

public Event()

public Event(const json::Value & root)

public Event(constEvent& root)

public virtual ~Event()

public virtual bool valid() const

public std::string name() const

public std::time_t time() const

public void setName(const std::string & name)

public void setTime(std::time_t time)

class scy::smpl::Form

class scy::smpl::Form
  : public scy::smpl::FormElement

Summary

Members

public Form()

public Form(json::Value & root)

public Form(Command& root)

public virtual ~Form()

public bool valid()

public std::string action() const

public bool partial() const

public void setAction(const std::string & action)

Possible "action" values form The form-processing entity is asking the form-submitting entity to complete a form. submit The form-submitting entity is submitting data to the form-processing entity. cancel The form-submitting entity has cancelled submission of data to the form-processing entity. result The form-processing entity is returning data to the form-submitting entity.

public void setPartial(bool flag)

Notifies the form is a partial section of the form. This is used for transmitting and updating live fields such as for auto-complete.

class scy::smpl::FormElement

Summary

Members

public FormElement()

public FormElement(json::Value & root,const std::string & type,const std::string & id,const std::string & label)

public FormElement(constFormElement& r)

publicFormElement& operator=(constFormElement& r)

public virtual ~FormElement()

public std::string type() const

public std::string id() const

public std::string label() const

public void setType(const std::string & type)

Possible "type" values page, section, text, text-multi, list, list-multi, checkbox, media, custom

public void setId(const std::string & id)

public void setLabel(const std::string & text)

public void setHint(const std::string & text)

public void setError(const std::string & error)

Sets and optional validation error message.

publicFormElementaddPage(const std::string & id,const std::string & label)

publicFormElementaddSection(const std::string & id,const std::string & label)

publicFormFieldaddField(const std::string & type,const std::string & id,const std::string & label)

publicFormFieldgetField(const std::string & id,bool partial)

public bool getField(const std::string & id,FormField& field,bool partial)

public bool hasField(const std::string & id,bool partial)

Returns true if the given Address matches any of the internal form element IDs. If the partial flag is set then substring matches will be counted.

public void setLive(bool flag)

Live fields or elements are used to submit partial sections a form, without sending the entire form.

public bool live() const

Returns true if this field is live, meaning the form-processing entity should auto-update this field's value whenever it changes.

public bool clearElements(const std::string & id,bool partial)

Clears child elements matching the given ID.

public void clear()

Clear the entire form.

public bool valid() const

Returns true if the form element is valid.

public int numElements()

Returns the number of child elements.

public bool hasErrors()

Returns true if any fields have errors.

public bool hasPages()

Returns true if the form has multiple pages.

public json::Value & root() const

protected json::Value * _root

The root pointer is just a reference to the externally managed JSON value memory.

class scy::smpl::FormField

class scy::smpl::FormField
  : public scy::smpl::FormElement

Summary

Members

public FormField()

public FormField(json::Value & root,const std::string & type,const std::string & id,const std::string & label)

public virtual ~FormField()

public void addOption(const std::string & key,const std::string & value)

Adds an option for list based fields.

public void addOption(const std::string & value)

public void setValue(const std::string & value)

Sets the value clearing all other values.

public void setValue(int value)

public void setValue(double value)

public void setValue(bool value)

public void addValue(const std::string & value)

Appends a value to the value array.

public void addValue(int value)

public void addValue(double value)

public void addValue(bool value)

public json::Value & values()

Returns a JSON array of all values.

public std::string value() const

Returns the first value. Most formats (except multi) only require single value.

public int intValue() const

public double doubleValue() const

public bool boolValue() const

class scy::smpl::Message

class scy::smpl::Message
  : public Value
  : public scy::IPacket

Summary

Members

public Message()

public Message(const json::Value & root)

public Message(constMessage& root)

public virtual ~Message()

public virtualIPacket* clone() const

public virtual bool valid() const

public virtual void clear()

public virtual void clearData()

public virtual void clearNotes()

public std::string type() const

public std::string id() const

publicAddressto() const

publicAddressfrom() const

public int status() const

public void setType(const std::string & type)

public void setTo(constPeer& to)

public void setTo(constAddress& to)

public void setTo(const std::string & to)

public void setFrom(constPeer& from)

public void setFrom(constAddress& from)

public void setFrom(const std::string & from)

public void setStatus(int code)

HTTP status codes are used to describe the message response. See also: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

public json::Value & notes()

public void setNote(const std::string & type,const std::string & text)

Set a note for the application Possible "type" values: info, warn, error

public void addNote(const std::string & type,const std::string & text)

public json::Value data(const std::string & name) const

public json::Value & data(const std::string & name)

public json::Value & setData(const std::string & name)

public void setData(const std::string & name,const char * data)

public void setData(const std::string & name,const std::string & data)

public void setData(const std::string & name,const json::Value & data)

public void setData(const std::string & name,int data)

public void removeData(const std::string & name)

public bool hasData(const std::string & name)

public virtual std::size_t read(constConstBuffer&)

Read/parse to the packet from the given input buffer. The number of bytes read is returned.

public virtual std::size_t read(const std::string & root)

public virtual void write(Buffer &) const

Copy/generate to the packet given output buffer. The number of bytes written can be obtained from the buffer.

Todo: It may be prefferable to use our pod types here instead of buffer input, but the current codebase requires that the buffer be dynamically resizable for some protocols...

virtual std::size_t write(MutableBuffer&) const = 0;

public bool isRequest() const

public virtual std::size_t size() const

The size of the packet in bytes.

This is the nember of bytes that will be written on a call to write(), but may not be the number of bytes that will be consumed by read().

public virtual void print(std::ostream & os) const

public inline virtual const char * className() const

class scy::smpl::Peer

class scy::smpl::Peer
  : public Value

This class represents a peer on the network. A Peer object may also contain arbitrary data set by the client to share with other peers on the network. See also: Address for further methods and basic accessors.

Summary

Members

public Peer()

public Peer(constPeer& r)

public Peer(const json::Value & r)

public virtual ~Peer()

publicAddressaddress() const

public std::string id() const

public std::string user() const

public std::string name() const

public std::string type() const

public std::string host() const

public void setID(const std::string & id)

public void setUser(const std::string & user)

public void setName(const std::string & name)

public void setType(const std::string & type)

public void setHost(const std::string & host)

public virtual bool valid()

Updates the peer from the given data object.

public void print(std::ostream & os) const

public inline virtual const char * className() const

class scy::smpl::Presence

class scy::smpl::Presence
  : public scy::smpl::Message

Summary

Members

public Presence()

public Presence(const json::Value & root)

public Presence(constPresence& root)

public virtual ~Presence()

public bool isProbe()

public void setProbe(bool flag)

class scy::smpl::Roster

class scy::smpl::Roster
  : public scy::LiveCollection< std::string, Peer >

The Roster provides a registry for active network peers indexed by session ID.

Summary

Members

public Roster()

public virtual ~Roster()

publicPeer* getByHost(const std::string & host)

Returns the first peer which matches the given host address.

public virtual PeerMap peers() const

public virtual void print(std::ostream & os) const

public inline virtual const char * className() const

class scy::smpl::SSLClient

class scy::smpl::SSLClient
  : public scy::smpl::Client

Summary

Members

public SSLClient(constClient::Options& options,uv::Loop * loop)

class scy::smpl::TCPClient

class scy::smpl::TCPClient
  : public scy::smpl::Client

Summary

Members

public TCPClient(constClient::Options& options,uv::Loop * loop)

struct scy::smpl::Address

The Address structure is an endpoint identifier for a peer on the network. The format is like so: user|id

Summary

Members

public std::string user

public std::string id

public Address()

public Address(const std::string & addr)

public Address(const std::string & user,const std::string & id)

public virtual ~Address()

public bool parse(const std::string & addr)

public bool valid() const

public void print(std::ostream & os) const

public std::string toString() const

public bool operator==(constAddress& r)

public bool operator==(std::string & r)

struct scy::smpl::CommandDelegate

struct scy::smpl::CommandDelegate
  : public scy::smpl::MessageDelegate

Summary

Members

public inline CommandDelegate(constFilter& filter)

public inline CommandDelegate(constCommandDelegate& r)

public inline virtual bool accepts(void * sender,IPacket& data,void * empty2,void * empty3,void * empty4)

struct scy::smpl::EventDelegate

struct scy::smpl::EventDelegate
  : public scy::smpl::MessageDelegate

Summary

Members

public inline EventDelegate()

public inline EventDelegate(constEventDelegate& r)

public inline virtual bool accepts(void * sender,IPacket& data,void * empty2,void * empty3,void * empty4)

struct scy::smpl::Filter

Summary

Members

publicBitwiseflags

public std::string path

public inline Filter(const std::string & path,unsigned flags)

public inline Filter(unsigned flags)

struct scy::smpl::MessageDelegate

struct scy::smpl::MessageDelegate
  : public scy::DelegateBase< IPacket & >

Summary

Members

publicFilterfilter

public inline MessageDelegate(constFilter& filter)

public inline MessageDelegate(constMessageDelegate& r)

public inline virtual bool accepts(void *,IPacket& data,void *,void *,void *)

struct scy::smpl::PresenceDelegate

struct scy::smpl::PresenceDelegate
  : public scy::smpl::MessageDelegate

Summary

Members

public inline PresenceDelegate()

public inline PresenceDelegate(constPresenceDelegate& r)

public inline virtual bool accepts(void * sender,IPacket& data,void * empty2,void * empty3,void * empty4)