Version 0.1.0 from FTP

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@16 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 152 insertions, 0 deletions

diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
new file mode 100755
index 000000000..a5d9c9121
--- /dev/null
+++ b/include/asterisk/channel.h
@@ -0,0 +1,152 @@
+/*
+ * Asterisk -- A telephony toolkit for Linux.
+ *
+ * General Asterisk channel definitions.
+ * 
+ * Copyright (C) 1999, Adtran Inc. and Linux Support Services, LLC
+ *
+ * Mark Spencer <markster@linux-support.net>
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License
+ */
+
+#ifndef _ASTERISK_CHANNEL_H
+#define _ASTERISK_CHANNEL_H
+
+#include <asterisk/frame.h>
+#include <asterisk/sched.h>
+#include <setjmp.h>
+#include <pthread.h>
+
+#if defined(__cplusplus) || defined(c_plusplus)
+extern "C" {
+#endif
+
+
+
+#define AST_CHANNEL_NAME 80
+#define AST_CHANNEL_MAX_STACK 32
+
+/* Max length an extension can be (unique) is this number */
+#define AST_MAX_EXTENSION 80
+
+struct ast_channel {
+	char name[AST_CHANNEL_NAME];		/* ASCII Description of channel name */
+	pthread_t blocker;					/* If anyone is blocking, this is them */
+	char *blockproc;					/* Procedure causing blocking */
+	int blocking;						/* Whether or not we're blocking */
+	struct sched_context *sched;		/* Schedule context */
+	int streamid;					/* For streaming playback, the schedule ID */
+	struct ast_filestream *stream;	/* Stream itself. */
+	struct ast_channel *trans;		/* Translator if present */
+	struct ast_channel *master;		/* Master channel, if this is a translator */
+	int fd;					/* File descriptor for channel -- all must have
+						   a file descriptor! */
+	char *type;				/* Type of channel */
+	int state;				/* State of line */
+	int rings;				/* Number of rings so far */
+	int stack;				/* Current level of application */
+	int format;				/* Kinds of data this channel can
+						   	   natively handle */
+	char *dnid;				/* Malloc'd Dialed Number Identifier */
+	char *callerid;			/* Malloc'd Caller ID */
+	char context[AST_MAX_EXTENSION];	/* Current extension context */
+	char exten[AST_MAX_EXTENSION];		/* Current extension number */
+	int priority;						/* Current extension priority */
+	void *app[AST_CHANNEL_MAX_STACK];	/* Application information -- see assigned numbers */
+	struct ast_channel_pvt *pvt;
+						/* Private channel implementation details */
+	jmp_buf jmp[AST_CHANNEL_MAX_STACK];		/* Jump buffer used for returning from applications */
+	struct ast_pbx *pbx;
+	struct ast_channel *next;		/* For easy linking */
+};
+
+
+/* Bits 0-15 of state are reserved for the state (up/down) of the line */
+
+#define AST_STATE_DOWN		0		/* Channel is down and available */
+#define AST_STATE_RESERVED	1		/* Channel is down, but reserved */
+#define AST_STATE_OFFHOOK	2		/* Channel is off hook */
+#define AST_STATE_DIALING	3		/* Digits (or equivalent) have been dialed */
+#define AST_STATE_RING		4		/* Line is ringing */
+#define AST_STATE_RINGING	5		/* Remote end is ringing */
+#define AST_STATE_UP		6		/* Line is up */
+#define AST_STATE_BUSY  	7		/* Line is busy */
+
+/* Bits 16-32 of state are reserved for flags */
+
+#define AST_STATE_MUTE		(1 << 16)	/* Do not transmit voice data */
+
+/* Request a channel of a given type, with data as optional information used
+   by the low level module */
+struct ast_channel *ast_request(char *type, int format, void *data);
+
+/* Called by a channel module to register the kind of channels it supports.
+   It supplies a brief type, a longer, but still short description, and a
+   routine that creates a channel */
+int ast_channel_register(char *type, char *description, int capabilities, 
+			struct ast_channel* (*requester)(char *type, int format, void *data));
+
+/* Unregister a channel class */
+void ast_channel_unregister(char *type);
+
+/* Hang up a channel -- chan is no longer valid after this call! */
+int ast_hangup(struct ast_channel *chan);
+
+/* Softly hangup up a channel -- call the protocol layer, but don't
+   destroy the channel structure (use this if you are trying to
+   safely hangup a channel managed by another thread. */
+int ast_softhangup(struct ast_channel *chan);
+
+/* Answer a ringing call */
+int ast_answer(struct ast_channel *chan);
+
+/* Place a call, take no longer than timeout ms.  Returns -1 on failure, 
+   0 on not enough time (does not auto matically stop ringing), and  
+   the number of seconds the connect took otherwise.  */
+int ast_call(struct ast_channel *chan, char *addr, int timeout);
+
+/* Misc stuff */
+
+/* Wait for input on a channel for a given # of milliseconds (<0 for indefinite).  
+  Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
+int ast_waitfor(struct ast_channel *chan, int ms);
+
+/* Wait for input on an array of channels for a given # of milliseconds. Return channel
+   with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
+
+struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
+
+/* This version works on fd's only.  Be careful with it. */
+int ast_waitfor_n_fd(int *fds, int n, int *ms);
+
+/* Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
+   best just stop reading frames and assume the channel has been
+   disconnected. */
+struct ast_frame *ast_read(struct ast_channel *chan);
+
+/* Write a frame to a channel */
+int ast_write(struct ast_channel *chan, struct ast_frame *frame);
+
+/* Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
+char ast_waitfordigit(struct ast_channel *c, int ms);
+
+/* Read in a digit string "s", max length "len", maximum timeout between 
+   digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
+   for the first digit */
+int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
+#define CHECK_BLOCKING(c) { 	 \
+							if ((c)->blocking) \
+								ast_log(LOG_WARNING, "Blocking '%s', already blocked by thread %ld in procedure %s\n", (c)->name, (c)->blocker, (c)->blockproc); \
+							else { \
+								(c)->blocker = pthread_self(); \
+								(c)->blockproc = __PRETTY_FUNCTION__; \
+									c->blocking = -1; } }
+
+#if defined(__cplusplus) || defined(c_plusplus)
+}
+#endif
+
+
+#endif