IRCBot Plugin API  v5
Classes | Macros | Enumerations
Remote Connection/Protocol API

Classes

struct  STREAM_INFO
 
struct  REMOTE_UPLOAD_DATA
 
struct  REMOTE_UPLOAD_START
 
struct  REMOTE_HEADER
 

Macros

#define MAX_REMOTE_PACKET_SIZE   4096
 

Enumerations

enum  REMOTE_COMMANDS {
  RCMD_LOGIN = 0x00, RCMD_QUERY_STREAM = 0x02, RCMD_ENABLE_SSL = 0x03, RCMD_GET_VERSION = 0x04,
  RCMD_REQ_LOGOUT = 0x10, RCMD_REQ_LOGIN = 0x11, RCMD_REQ_CURRENT = 0x12, RCMD_SEND_REQ = 0x13,
  RCMD_REQ = 0x14, RCMD_SEND_DED = 0x15, RCMD_FIND_RESULTS = 0x16, RCMD_DOSPAM = 0x20,
  RCMD_DIE = 0x21, RCMD_BROADCAST_MSG = 0x22, RCMD_RESTART = 0x23, RCMD_RCONS_OPEN = 0x24,
  RCMD_RCONS_CLOSE = 0x25, RCMD_REHASH = 0x26, RCMD_UPLOAD_START = 0x27, RCMD_UPLOAD_DATA = 0x28,
  RCMD_UPLOAD_DONE = 0x29, RCMD_SRC_COUNTDOWN = 0x30, RCMD_SRC_FORCE_OFF = 0x31, RCMD_SRC_FORCE_ON = 0x32,
  RCMD_SRC_NEXT = 0x33, RCMD_SRC_RELOAD = 0x34, RCMD_SRC_GET_SONG = 0x35, RCMD_SRC_RATE_SONG = 0x36,
  RCMD_SRC_STATUS = 0x37, RCMD_SRC_GET_NAME = 0x38, RCMD_GETUSERINFO = 0x40, RCMD_LOGIN_FAILED = 0x00,
  RCMD_LOGIN_OK = 0x01, RCMD_ENABLE_SSL_ACK = 0x03, RCMD_IRCBOT_VERSION = 0x04, RCMD_REQ_LOGOUT_ACK = 0x10,
  RCMD_REQ_LOGIN_ACK = 0x11, RCMD_REQ_INCOMING = 0x12, RCMD_STREAM_INFO = 0x13, RCMD_FIND_QUERY = 0x14,
  RCMD_RCONS_OPEN_ACK = 0x20, RCMD_RCONS_LINE = 0x21, RCMD_RCONS_CLOSE_ACK = 0x22, RCMD_UPLOAD_FAILED = 0x23,
  RCMD_UPLOAD_OK = 0x24, RCMD_UPLOAD_DATA_ACK = 0x25, RCMD_UPLOAD_DONE_ACK = 0x26, RCMD_USERINFO = 0x40,
  RCMD_USERNOTFOUND = 0x41, RCMD_GENERIC_MSG = 0xFE, RCMD_GENERIC_ERROR = 0xFF
}
 

Detailed Description

The Remote Protocol is much better documented on the wiki, so you may want to check it out for more information.

See also
http://wiki.shoutirc.com/index.php/Remote_Commands

Macro Definition Documentation

#define MAX_REMOTE_PACKET_SIZE   4096

Enumeration Type Documentation

Enumerator
RCMD_LOGIN 
RCMD_QUERY_STREAM 
RCMD_ENABLE_SSL 
RCMD_GET_VERSION 
RCMD_REQ_LOGOUT 
RCMD_REQ_LOGIN 
RCMD_REQ_CURRENT 
RCMD_SEND_REQ 
RCMD_REQ 
RCMD_SEND_DED 
RCMD_FIND_RESULTS 
RCMD_DOSPAM 
RCMD_DIE 
RCMD_BROADCAST_MSG 
RCMD_RESTART 
RCMD_RCONS_OPEN 
RCMD_RCONS_CLOSE 
RCMD_REHASH 
RCMD_UPLOAD_START 
RCMD_UPLOAD_DATA 
RCMD_UPLOAD_DONE 
RCMD_SRC_COUNTDOWN 
RCMD_SRC_FORCE_OFF 
RCMD_SRC_FORCE_ON 
RCMD_SRC_NEXT 
RCMD_SRC_RELOAD 
RCMD_SRC_GET_SONG 
RCMD_SRC_RATE_SONG 
RCMD_SRC_STATUS 
RCMD_SRC_GET_NAME 
RCMD_GETUSERINFO 
RCMD_LOGIN_FAILED 
RCMD_LOGIN_OK 
RCMD_ENABLE_SSL_ACK 
RCMD_IRCBOT_VERSION 
RCMD_REQ_LOGOUT_ACK 
RCMD_REQ_LOGIN_ACK 
RCMD_REQ_INCOMING 
RCMD_STREAM_INFO 
RCMD_FIND_QUERY 
RCMD_RCONS_OPEN_ACK 
RCMD_RCONS_LINE 
RCMD_RCONS_CLOSE_ACK 
RCMD_UPLOAD_FAILED 
RCMD_UPLOAD_OK 
RCMD_UPLOAD_DATA_ACK 
RCMD_UPLOAD_DONE_ACK 
RCMD_USERINFO 
RCMD_USERNOTFOUND 
RCMD_GENERIC_MSG 
RCMD_GENERIC_ERROR