AESOP Network Protocol [AESOP Core Libraries]

This is the base messaging layer for the aesop server. More...

Collaboration diagram for AESOP Network Protocol:

Classes
struct	aesop::tcp_payload_t
	A tcp_payload_t consists of a namespace, a command, and then a hash of arguments. More...
Modules
	AESOP Protocol Messages
	All TCP AESOP protocol messages have the same basic format.
Enumerations
enum	aesop::eDefaultPorts {   aesop::eDefaultPort_clientUdp = 20051,   aesop::eDefaultPort_serverUdp = 20050,   aesop::eDefaultPort_serverTcp = 20051,   aesop::eDefaultPort_Invalid = 0 }
	these are the default TCP/UDP ports used by the AESOP engine. More...

---

Detailed Description

This is the base messaging layer for the aesop server.

It has a very simple message-passing format (datahashes in clear text over the wire), with simple syntax checking.

This library is intended to be used to easily create aesop-specific messages. Use the netlib networking library to create connections, and send/receive messages over the network.

See the netlib documentation at http://wavepacket-lib.sourceforge.net/group__netlib.html

NOTE: like the lower-level netlib networking library, this API is NOT threadsafe. Thread synchronization should be handled at a higher level.

---

Enumeration Type Documentation

enum aesop::eDefaultPorts

these are the default TCP/UDP ports used by the AESOP engine.

These can be overridden! If you run a server, you can specify the client and server ports to be used for your instance. But in the lack of overrides, these are the ports that will be used. These particular values were chosen because they appear to be unused by other programs.

Enumerator:

eDefaultPort_clientUdp	client UDP send/receive
eDefaultPort_serverUdp	server UPD send/receive
eDefaultPort_serverTcp	server TCP listening port
eDefaultPort_Invalid

Definition at line 81 of file protocol.h.