-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathastman.h
More file actions
165 lines (164 loc) · 7.77 KB
/
astman.h
File metadata and controls
165 lines (164 loc) · 7.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
#ifndef ASTMAN_H_INCLUDED
#define ASTMAN_H_INCLUDED
/*******************************************************************************
* astapi - library for using Asterisk Manager API.
* Copyright (C) 2010 Baligh GUESMI
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc.,
******************************************************************************/
/*******************************************************************************
* @file astman.h
* @brief
* @author Baligh.GUESMI
* @date 20100524
******************************************************************************/
#include <netinet/in.h> /* struct sockaddr_in */
#include "astapi.h"
/*******************************************************************************
* @def CRLF
* @brief
******************************************************************************/
#define CRLF "\r\n"
/*******************************************************************************
* @struct message
* @brief The struct representing the message command to send
******************************************************************************/
struct message {
int hdrcount; /**!< Header count */
int gettingdata; /**!< data */
char headers[MAX_HEADERS][MAX_LEN]; /**!< Headers list */
} __attribute__((packed));
/*******************************************************************************
* @struct mansession
* @brief The struct of an opened AMI session
******************************************************************************/
struct mansession {
int fd; /**!< the discriptor to the socket */
char inbuf[MAX_LEN]; /**!< buffer */
unsigned int inlen; /**!< length of the buffer */
struct sockaddr_in sin; /**!< address of the socket */
struct event {
char *event; /**!< the event ID */
int (*func)(struct mansession *s, struct message *m); /**!< callback associated to this event */
} events[MAX_EVENTS]; /**!< event registred to */
int eventcount; /**!< the real count of event that the session is registred to */
int debug:1; /**!< active/desactivated DEBUG */
} __attribute__((packed));
/*******************************************************************************
* @fn astman_strlen_zero(const char *s)
* @brief inline function to test if the given char is not empty
* @param IN s
* @return >0 if the given char is not empty
******************************************************************************/
static inline __attribute__((always_inline)) int astman_strlen_zero(const char *s)
{
return (!s || (*s == '\0'));
}
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
int astman_add_param(char *buf, int buflen, char *header, const char *value);
/*******************************************************************************
* \fn int astman_manager_action_params(struct mansession *s, char *action, char *params)
* \brief
* \return
******************************************************************************/
int astman_manager_action_params(struct mansession *s, char *action, char *params);
/*******************************************************************************
* \fn int astman_wait_for_response(struct mansession *s, struct message *msg, time_t timeout)
* \brief
* \return
******************************************************************************/
int astman_wait_for_response(struct mansession *s, struct message *msg, time_t timeout);
/*******************************************************************************
* @fn char *astman_get_header(struct message *m, const char *var)
* @brief
* @warning
* @return
******************************************************************************/
char *astman_get_header(struct message *m, const char *var);
/*******************************************************************************
* @fn int astman_manager_action(struct mansession *s, char *action, char *fmt, ...)
* @brief
* @return
******************************************************************************/
int astman_manager_action(struct mansession *s, char *action, char *fmt, ...);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
struct mansession *astman_open(void);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
int astman_connect(struct mansession *s, char *hostname, int port);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
int astman_login(struct mansession *s, char *username, char *secret);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
int astman_logoff(struct mansession *s);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
void astman_disconnect(struct mansession *s);
/*******************************************************************************
* \fn astman_add_param(char *buf, int buflen, char *header, char *value)
* \brief Add a new parameter to the Command
* \param buf
* \param buflen
* \param header
* \param value
* \return Number of wrote characters into the buf
******************************************************************************/
void astman_dump_message(struct message *m);
#endif // ASTMAN_H_INCLUDED