lcrsocket.h

   1 /*****************************************************************************\
   2 **                                                                           **
   3 ** Linux Call Router                                                         **
   4 **                                                                           **
   5 **---------------------------------------------------------------------------**
   6 ** Copyright: Andreas Eversberg                                              **
   7 **                                                                           **
   8 ** Administration tool header file                                           **
   9 **                                                                           **
  10 \*****************************************************************************/
  11
  12 #define SOCKET_NAME "/var/run/LCR.socket"
  13
  14 /* structures that define message between admin-tool and pbx */
  15
  16 enum { /* messages */
  17         ADMIN_REQUEST_CMD_INTERFACE,
  18         ADMIN_RESPONSE_CMD_INTERFACE,
  19         ADMIN_REQUEST_CMD_ROUTE,
  20         ADMIN_RESPONSE_CMD_ROUTE,
  21         ADMIN_REQUEST_CMD_DIAL,
  22         ADMIN_RESPONSE_CMD_DIAL,
  23         ADMIN_REQUEST_CMD_RELEASE,
  24         ADMIN_RESPONSE_CMD_RELEASE,
  25         ADMIN_REQUEST_CMD_BLOCK,
  26         ADMIN_RESPONSE_CMD_BLOCK,
  27         ADMIN_REQUEST_STATE,
  28         ADMIN_RESPONSE_STATE,
  29         ADMIN_RESPONSE_S_REMOTE,
  30         ADMIN_RESPONSE_S_INTERFACE,
  31         ADMIN_RESPONSE_S_PORT,
  32         ADMIN_RESPONSE_S_EPOINT,
  33         ADMIN_RESPONSE_S_JOIN,
  34         ADMIN_CALL_SETUP,
  35         ADMIN_CALL_SETUP_ACK,
  36         ADMIN_CALL_PROCEEDING,
  37         ADMIN_CALL_ALERTING,
  38         ADMIN_CALL_CONNECT,
  39         ADMIN_CALL_DISCONNECT,
  40         ADMIN_CALL_RELEASE,
  41         ADMIN_CALL_NOTIFY,
  42         ADMIN_TRACE_REQUEST,
  43         ADMIN_TRACE_RESPONSE,
  44         ADMIN_MESSAGE,
  45 };
  46
  47 struct admin_response_cmd {
  48         int             error;          /* error code 0 = ok*/
  49         char            message[256];   /* info / response text */
  50         int             block;
  51         int             portnum;
  52 };
  53
  54 struct admin_response_state {
  55         char            version_string[64];
  56         struct tm       tm;
  57         char            logfile[128];
  58         int             interfaces;
  59         int             remotes;
  60         int             joins;
  61         int             epoints;
  62         int             ports;
  63 };
  64
  65 struct admin_response_interface {
  66         char            interface_name[32];
  67         int             portnum;
  68         int             block;
  69         int             ntmode;
  70         int             ptp;
  71         int             pri;
  72         int             extension;
  73         int             use; /* number of ports that use this interface */
  74         int             l1link; /* down(0) or up(1) */
  75         int             l2link; /* down(0) or up(1) */
  76         int             los, ais, rdi, slip_tx, slip_rx;
  77         int             channels;
  78         char            busy[256]; /* if port is idle(0) busy(1) */
  79         unsigned int    port[256]; /* current port */
  80 };
  81
  82 struct admin_response_remote {
  83         char            name[32]; /* name of remote application */
  84 };
  85
  86 struct admin_response_join {
  87         unsigned int    serial; /* join serial number */
  88         char            remote[32]; /* remote application name */
  89         unsigned int    partyline;
  90 };
  91
  92 struct admin_response_epoint {
  93         unsigned int    serial;
  94         unsigned int    join; /* link to join */
  95 //      int             join_notify; /* if relation notified on hold */
  96 //      int             join_hold; /* if relation on hold */
  97         int             rx_state;
  98         int             tx_state;
  99         int             state;
 100         char            terminal[16];
 101         char            callerid[64];
 102         char            dialing[64];
 103         char            action[32];
 104         int             park; /* if parked */
 105         int             park_len;
 106         unsigned char   park_callid[8];
 107         int             crypt; /* crypt state */
 108 };
 109
 110 struct admin_response_port {
 111         unsigned int    serial; /* port serial number */
 112         char            name[64]; /* name of port */
 113         unsigned int    epoint; /* link to epoint */
 114         int             state;
 115         int             isdn; /* if port is isdn */
 116         int             isdn_chan; /* bchannel number */
 117         int             isdn_hold; /* on hold */
 118         int             isdn_ces; /* ces to use (>=0)*/
 119 };
 120
 121 struct admin_call {
 122         char            interface[64]; /* name of port */
 123         char            callerid[64]; /* use caller id */
 124         char            dialing[64]; /* number to dial */
 125         int             present; /* presentation */
 126         int             cause; /* cause to send */
 127         int             location;
 128         int             notify;
 129         int             bc_capa;
 130         int             bc_mode;
 131         int             bc_info1;
 132         int             hlc;
 133         int             exthlc;
 134 };
 135
 136 struct admin_trace_req {
 137         int             detail;
 138         char            category;
 139         int             port;
 140         char            interface[64];
 141         char            caller[34];
 142         char            dialing[64];
 143 };
 144
 145 struct admin_trace_rsp {
 146         char            text[1024];
 147 };
 148
 149 struct admin_msg {
 150         int             type; /* type of message */
 151         unsigned int    ref; /* reference to individual endpoints */
 152         union parameter param; /* parameter union */
 153 };
 154
 155 struct admin_message {
 156         int message; /* type of admin message */
 157         union u {
 158                 struct admin_response_cmd       x;
 159                 struct admin_response_state     s;
 160                 struct admin_response_interface i;
 161                 struct admin_response_port      p;
 162                 struct admin_response_epoint    e;
 163                 struct admin_response_join      j;
 164                 struct admin_response_remote    r;
 165                 struct admin_call               call;
 166                 struct admin_msg                msg;
 167                 struct admin_trace_req          trace_req;
 168                 struct admin_trace_rsp          trace_rsp;
 169         } u;
 170 };
 171
 172 /* call states */
 173 enum {
 174         ADMIN_STATE_IDLE,
 175         ADMIN_STATE_IN_SETUP,
 176         ADMIN_STATE_OUT_SETUP,
 177         ADMIN_STATE_IN_OVERLAP,
 178         ADMIN_STATE_OUT_OVERLAP,
 179         ADMIN_STATE_IN_PROCEEDING,
 180         ADMIN_STATE_OUT_PROCEEDING,
 181         ADMIN_STATE_IN_ALERTING,
 182         ADMIN_STATE_OUT_ALERTING,
 183         ADMIN_STATE_CONNECT,
 184         ADMIN_STATE_IN_DISCONNECT,
 185         ADMIN_STATE_OUT_DISCONNECT,
 186 };