smdi.h File Reference

SMDI support for Asterisk. More...

#include <termios.h>
#include <time.h>
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/astobj.h"
#include "asterisk/optional_api.h"

Include dependency graph for smdi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_smdi_md_message
	An SMDI message desk message. More...
struct	ast_smdi_mwi_message
	An SMDI message waiting indicator message. More...
Defines
#define	SMDI_MAX_FILENAME_LEN   256
#define	SMDI_MAX_STATION_NUM_LEN   10
#define	SMDI_MESG_DESK_NUM_LEN   3
#define	SMDI_MESG_DESK_TERM_LEN   4
#define	SMDI_MWI_FAIL_CAUSE_LEN   3
Functions
static void	__init__ast_smdi_interface_find (void)
static void	__init__ast_smdi_interface_unref (void)
static void	__init__ast_smdi_md_message_destroy (void)
static void	__init__ast_smdi_md_message_pop (void)
static void	__init__ast_smdi_md_message_putback (void)
static void	__init__ast_smdi_md_message_wait (void)
static void	__init__ast_smdi_mwi_message_destroy (void)
static void	__init__ast_smdi_mwi_message_pop (void)
static void	__init__ast_smdi_mwi_message_putback (void)
static void	__init__ast_smdi_mwi_message_wait (void)
static void	__init__ast_smdi_mwi_message_wait_station (void)
static void	__init__ast_smdi_mwi_set (void)
static void	__init__ast_smdi_mwi_unset (void)
static struct ast_smdi_interface *	__stub__ast_smdi_interface_find (const char *iface_name)
	Find an SMDI interface with the specified name.
static void	__stub__ast_smdi_interface_unref (struct ast_smdi_interface *iface)
static void	__stub__ast_smdi_md_message_destroy (struct ast_smdi_md_message *msg)
	ast_smdi_md_message destructor.
static struct ast_smdi_md_message *	__stub__ast_smdi_md_message_pop (struct ast_smdi_interface *iface)
	Get the next SMDI message from the queue.
static void	__stub__ast_smdi_md_message_putback (struct ast_smdi_interface *iface, struct ast_smdi_md_message *msg)
	Put an SMDI message back in the front of the queue.
static struct ast_smdi_md_message *	__stub__ast_smdi_md_message_wait (struct ast_smdi_interface *iface, int timeout)
	Get the next SMDI message from the queue.
static void	__stub__ast_smdi_mwi_message_destroy (struct ast_smdi_mwi_message *msg)
	ast_smdi_mwi_message destructor.
static struct ast_smdi_mwi_message *	__stub__ast_smdi_mwi_message_pop (struct ast_smdi_interface *iface)
	Get the next SMDI message from the queue.
static void	__stub__ast_smdi_mwi_message_putback (struct ast_smdi_interface *iface, struct ast_smdi_mwi_message *msg)
	Put an SMDI message back in the front of the queue.
static struct ast_smdi_mwi_message *	__stub__ast_smdi_mwi_message_wait (struct ast_smdi_interface *iface, int timeout)
	Get the next SMDI message from the queue.
static struct ast_smdi_mwi_message *	__stub__ast_smdi_mwi_message_wait_station (struct ast_smdi_interface *iface, int timeout, const char *station)
static int	__stub__ast_smdi_mwi_set (struct ast_smdi_interface *iface, const char *mailbox)
	Set the MWI indicator for a mailbox.
static int	__stub__ast_smdi_mwi_unset (struct ast_smdi_interface *iface, const char *mailbox)
	Unset the MWI indicator for a mailbox.
static	typeof (__stub__ast_smdi_mwi_message_destroy) __ref__ast_smdi_mwi_message_destroy
static	typeof (__stub__ast_smdi_md_message_destroy) __ref__ast_smdi_md_message_destroy
static	typeof (__stub__ast_smdi_mwi_unset) __ref__ast_smdi_mwi_unset
static	typeof (__stub__ast_smdi_mwi_set) __ref__ast_smdi_mwi_set
static	typeof (__stub__ast_smdi_interface_find) __ref__ast_smdi_interface_find
static	typeof (__stub__ast_smdi_mwi_message_putback) __ref__ast_smdi_mwi_message_putback
static	typeof (__stub__ast_smdi_mwi_message_wait_station) __ref__ast_smdi_mwi_message_wait_station
static	typeof (__stub__ast_smdi_mwi_message_wait) __ref__ast_smdi_mwi_message_wait
static	typeof (__stub__ast_smdi_mwi_message_pop) __ref__ast_smdi_mwi_message_pop
static	typeof (__stub__ast_smdi_md_message_putback) __ref__ast_smdi_md_message_putback
static	typeof (__stub__ast_smdi_md_message_wait) __ref__ast_smdi_md_message_wait
static	typeof (__stub__ast_smdi_md_message_pop) __ref__ast_smdi_md_message_pop
static	typeof (__stub__ast_smdi_interface_unref) __ref__ast_smdi_interface_unref

---

Detailed Description

SMDI support for Asterisk.

Author:

Matthew A. Nicholson <mnicholson@digium.com>

Russell Bryant <russell@digium.com>

Definition in file smdi.h.

---

Define Documentation

#define SMDI_MAX_FILENAME_LEN   256

Definition at line 46 of file smdi.h.

#define SMDI_MAX_STATION_NUM_LEN   10

Definition at line 45 of file smdi.h.

#define SMDI_MESG_DESK_NUM_LEN   3

Definition at line 42 of file smdi.h.

#define SMDI_MESG_DESK_TERM_LEN   4

Definition at line 43 of file smdi.h.

#define SMDI_MWI_FAIL_CAUSE_LEN   3

Definition at line 44 of file smdi.h.

---

Function Documentation

static void __init__ast_smdi_interface_find

(

void

)

[static]

Definition at line 192 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_interface_unref

(

void

)

[static]

Definition at line 90 of file smdi.h.

{ return; });

static void __init__ast_smdi_md_message_destroy

(

void

)

[static]

Definition at line 215 of file smdi.h.

{ return; });

static void __init__ast_smdi_md_message_pop

(

void

)

[static]

Definition at line 104 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_md_message_putback

(

void

)

[static]

Definition at line 133 of file smdi.h.

{ return; });

static void __init__ast_smdi_md_message_wait

(

void

)

[static]

Definition at line 120 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_mwi_message_destroy

(

void

)

[static]

Definition at line 220 of file smdi.h.

{ return; });

static void __init__ast_smdi_mwi_message_pop

(

void

)

[static]

Definition at line 147 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_mwi_message_putback

(

void

)

[static]

Definition at line 180 of file smdi.h.

{ return; });

static void __init__ast_smdi_mwi_message_wait

(

void

)

[static]

Definition at line 163 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_mwi_message_wait_station

(

void

)

[static]

Definition at line 167 of file smdi.h.

{ return NULL; });

static void __init__ast_smdi_mwi_set

(

void

)

[static]

Definition at line 201 of file smdi.h.

{ return -1; });

static void __init__ast_smdi_mwi_unset

(

void

)

[static]

Definition at line 210 of file smdi.h.

{ return -1; });

static struct ast_smdi_interface* __stub__ast_smdi_interface_find

(

const char *

iface_name

)

[static, read]

Find an SMDI interface with the specified name.

Parameters:

iface_name

the name/port of the interface to search for.

Returns:

a pointer to the interface located or NULL if none was found. This actually returns an ASTOBJ reference and should be released using ASTOBJ_UNREF(iface, ast_smdi_interface_destroy).

Definition at line 192 of file smdi.h.

{ return NULL; });

static void __stub__ast_smdi_interface_unref

(

struct ast_smdi_interface *

iface

)

[static]

Definition at line 90 of file smdi.h.

{ return; });

static void __stub__ast_smdi_md_message_destroy

(

struct ast_smdi_md_message *

msg

)

[static]

ast_smdi_md_message destructor.

Definition at line 215 of file smdi.h.

{ return; });

static struct ast_smdi_md_message* __stub__ast_smdi_md_message_pop

(

struct ast_smdi_interface *

iface

)

[static, read]

Get the next SMDI message from the queue.

Parameters:

iface

a pointer to the interface to use.

This function pulls the first unexpired message from the SMDI message queue on the specified interface. It will purge all expired SMDI messages before returning.

Returns:

the next SMDI message, or NULL if there were no pending messages.

Definition at line 104 of file smdi.h.

{ return NULL; });

static void __stub__ast_smdi_md_message_putback	(	struct ast_smdi_interface *	iface,
		struct ast_smdi_md_message *	msg
	)			[static]

Put an SMDI message back in the front of the queue.

Parameters:

	iface	a pointer to the interface to use.
	msg	a pointer to the message to use.

This function puts a message back in the front of the specified queue. It should be used if a message was popped but is not going to be processed for some reason, and the message needs to be returned to the queue.

Definition at line 133 of file smdi.h.

{ return; });

static struct ast_smdi_md_message* __stub__ast_smdi_md_message_wait	(	struct ast_smdi_interface *	iface,
		int	timeout
	)			[static, read]

Get the next SMDI message from the queue.

Parameters:

	iface	a pointer to the interface to use.
	timeout	the time to wait before returning in milliseconds.

This function pulls a message from the SMDI message queue on the specified interface. If no message is available this function will wait the specified amount of time before returning.

Returns:

the next SMDI message, or NULL if there were no pending messages and the timeout has expired.

Definition at line 120 of file smdi.h.

{ return NULL; });

static void __stub__ast_smdi_mwi_message_destroy

(

struct ast_smdi_mwi_message *

msg

)

[static]

ast_smdi_mwi_message destructor.

Definition at line 220 of file smdi.h.

{ return; });

static struct ast_smdi_mwi_message* __stub__ast_smdi_mwi_message_pop

(

struct ast_smdi_interface *

iface

)

[static, read]

Get the next SMDI message from the queue.

Parameters:

iface

a pointer to the interface to use.

This function pulls the first unexpired message from the SMDI message queue on the specified interface. It will purge all expired SMDI messages before returning.

Returns:

the next SMDI message, or NULL if there were no pending messages.

Definition at line 147 of file smdi.h.

{ return NULL; });

static void __stub__ast_smdi_mwi_message_putback	(	struct ast_smdi_interface *	iface,
		struct ast_smdi_mwi_message *	msg
	)			[static]

Put an SMDI message back in the front of the queue.

Parameters:

	iface	a pointer to the interface to use.
	msg	a pointer to the message to use.

This function puts a message back in the front of the specified queue. It should be used if a message was popped but is not going to be processed for some reason, and the message needs to be returned to the queue.

Definition at line 180 of file smdi.h.

{ return; });

static struct ast_smdi_mwi_message* __stub__ast_smdi_mwi_message_wait	(	struct ast_smdi_interface *	iface,
		int	timeout
	)			[static, read]

Get the next SMDI message from the queue.

Parameters:

	iface	a pointer to the interface to use.
	timeout	the time to wait before returning in milliseconds.

This function pulls a message from the SMDI message queue on the specified interface. If no message is available this function will wait the specified amount of time before returning.

Returns:

the next SMDI message, or NULL if there were no pending messages and the timeout has expired.

Definition at line 163 of file smdi.h.

{ return NULL; });

static struct ast_smdi_mwi_message* __stub__ast_smdi_mwi_message_wait_station	(	struct ast_smdi_interface *	iface,
		int	timeout,
		const char *	station
	)			[static, read]

Definition at line 167 of file smdi.h.

{ return NULL; });

static int __stub__ast_smdi_mwi_set	(	struct ast_smdi_interface *	iface,
		const char *	mailbox
	)			[static]

Set the MWI indicator for a mailbox.

Parameters:

	iface	the interface to use.
	mailbox	the mailbox to use.

Definition at line 201 of file smdi.h.

{ return -1; });

static int __stub__ast_smdi_mwi_unset	(	struct ast_smdi_interface *	iface,
		const char *	mailbox
	)			[static]

Unset the MWI indicator for a mailbox.

Parameters:

	iface	the interface to use.
	mailbox	the mailbox to use.

Definition at line 210 of file smdi.h.

{ return -1; });

static typeof

(

__stub__ast_smdi_mwi_message_destroy

)

[static]

static typeof

(

__stub__ast_smdi_md_message_destroy

)

[static]

static typeof

(

__stub__ast_smdi_mwi_unset

)

[static]

static typeof

(

__stub__ast_smdi_mwi_set

)

[static]

static typeof

(

__stub__ast_smdi_interface_find

)

[static]

static typeof

(

__stub__ast_smdi_mwi_message_putback

)

[static]

static typeof

(

__stub__ast_smdi_mwi_message_wait_station

)

[static]

static typeof

(

__stub__ast_smdi_mwi_message_wait

)

[static]

static typeof

(

__stub__ast_smdi_mwi_message_pop

)

[static]

static typeof

(

__stub__ast_smdi_md_message_putback

)

[static]

static typeof

(

__stub__ast_smdi_md_message_wait

)

[static]

static typeof

(

__stub__ast_smdi_md_message_pop

)

[static]

static typeof

(

__stub__ast_smdi_interface_unref

)

[static]