[apple/libc.git] / include / protocols / talkd.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1983, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)talkd.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _TALKD_H_
#define	_TALKD_H_

/*
 * This describes the protocol used by the talk server and clients.
 *
 * The talk server acts a repository of invitations, responding to
 * requests by clients wishing to rendezvous for the purpose of
 * holding a conversation.  In normal operation, a client, the caller,
 * initiates a rendezvous by sending a CTL_MSG to the server of
 * type LOOK_UP.  This causes the server to search its invitation
 * tables to check if an invitation currently exists for the caller
 * (to speak to the callee specified in the message).  If the lookup
 * fails, the caller then sends an ANNOUNCE message causing the server
 * to broadcast an announcement on the callee's login ports requesting
 * contact.  When the callee responds, the local server uses the
 * recorded invitation to respond with the appropriate rendezvous
 * address and the caller and callee client programs establish a
 * stream connection through which the conversation takes place.
 */

/*
 * Client->server request message format.
 */
typedef struct {
	unsigned char	vers;		/* protocol version */
	unsigned char	type;		/* request type, see below */
	unsigned char	answer;		/* not used */
	unsigned char	pad;
	unsigned long	id_num;		/* message id */
	struct		osockaddr addr;		/* old (4.3) style */
	struct		osockaddr ctl_addr;	/* old (4.3) style */
	long		pid;		/* caller's process id */
#define	NAME_SIZE	12
	char		l_name[NAME_SIZE];/* caller's name */
	char		r_name[NAME_SIZE];/* callee's name */
#define	TTY_SIZE	16
	char		r_tty[TTY_SIZE];/* callee's tty name */
} CTL_MSG;

/*
 * Server->client response message format.
 */
typedef struct {
	unsigned char	vers;		/* protocol version */
	unsigned char	type;		/* type of request message, see below */
	unsigned char	answer;		/* respose to request message, see below */
	unsigned char	pad;
	unsigned long	id_num;		/* message id */
	struct	osockaddr addr;		/* address for establishing conversation */
} CTL_RESPONSE;

#define	TALK_VERSION	1		/* protocol version */

/* message type values */
#define LEAVE_INVITE	0	/* leave invitation with server */
#define LOOK_UP		1	/* check for invitation by callee */
#define DELETE		2	/* delete invitation by caller */
#define ANNOUNCE	3	/* announce invitation by caller */

/* answer values */
#define SUCCESS		0	/* operation completed properly */
#define NOT_HERE	1	/* callee not logged in */
#define FAILED		2	/* operation failed for unexplained reason */
#define MACHINE_UNKNOWN	3	/* caller's machine name unknown */
#define PERMISSION_DENIED 4	/* callee's tty doesn't permit announce */
#define UNKNOWN_REQUEST	5	/* request has invalid type value */
#define	BADVERSION	6	/* request has invalid protocol version */
#define	BADADDR		7	/* request has invalid addr value */
#define	BADCTLADDR	8	/* request has invalid ctl_addr value */

/*
 * Operational parameters.
 */
#define MAX_LIFE	60	/* max time daemon saves invitations */
/* RING_WAIT should be 10's of seconds less than MAX_LIFE */
#define RING_WAIT	30	/* time to wait before resending invitation */

#endif /* !_TALKD_H_ */
Commit	Line	Data
5b2abdfb A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
734aad71 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
5b2abdfb A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
5b2abdfb A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
5b2abdfb A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/*
	24	* Copyright (c) 1983, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
	37	* This product includes software developed by the University of
	38	* California, Berkeley and its contributors.
	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
	54	*
	55	* @(#)talkd.h 8.1 (Berkeley) 6/2/93
	56	*/
	57
	58	#ifndef _TALKD_H_
	59	#define _TALKD_H_
	60
	61	/*
	62	* This describes the protocol used by the talk server and clients.
	63	*
	64	* The talk server acts a repository of invitations, responding to
	65	* requests by clients wishing to rendezvous for the purpose of
	66	* holding a conversation. In normal operation, a client, the caller,
	67	* initiates a rendezvous by sending a CTL_MSG to the server of
	68	* type LOOK_UP. This causes the server to search its invitation
	69	* tables to check if an invitation currently exists for the caller
	70	* (to speak to the callee specified in the message). If the lookup
	71	* fails, the caller then sends an ANNOUNCE message causing the server
	72	* to broadcast an announcement on the callee's login ports requesting
	73	* contact. When the callee responds, the local server uses the
	74	* recorded invitation to respond with the appropriate rendezvous
	75	* address and the caller and callee client programs establish a
	76	* stream connection through which the conversation takes place.
	77	*/
	78
	79	/*
	80	* Client->server request message format.
	81	*/
	82	typedef struct {
3d9156a7 A	83	unsigned char vers; /* protocol version */
	84	unsigned char type; /* request type, see below */
	85	unsigned char answer; /* not used */
	86	unsigned char pad;
	87	unsigned long id_num; /* message id */
	88	struct osockaddr addr; /* old (4.3) style */
	89	struct osockaddr ctl_addr; /* old (4.3) style */
	90	long pid; /* caller's process id */
5b2abdfb	91	#define NAME_SIZE 12
3d9156a7 A	92	char l_name[NAME_SIZE];/* caller's name */
3d9156a7 A	93	char r_name[NAME_SIZE];/* callee's name */
5b2abdfb	94	#define TTY_SIZE 16
3d9156a7	95	char r_tty[TTY_SIZE];/* callee's tty name */
5b2abdfb A	96	} CTL_MSG;
	97
	98	/*
	99	* Server->client response message format.
	100	*/
	101	typedef struct {
3d9156a7 A	102	unsigned char vers; /* protocol version */
	103	unsigned char type; /* type of request message, see below */
	104	unsigned char answer; /* respose to request message, see below */
	105	unsigned char pad;
	106	unsigned long id_num; /* message id */
	107	struct osockaddr addr; /* address for establishing conversation */
5b2abdfb A	108	} CTL_RESPONSE;
	109
	110	#define TALK_VERSION 1 /* protocol version */
	111
	112	/* message type values */
	113	#define LEAVE_INVITE 0 /* leave invitation with server */
	114	#define LOOK_UP 1 /* check for invitation by callee */
	115	#define DELETE 2 /* delete invitation by caller */
	116	#define ANNOUNCE 3 /* announce invitation by caller */
	117
	118	/* answer values */
	119	#define SUCCESS 0 /* operation completed properly */
	120	#define NOT_HERE 1 /* callee not logged in */
	121	#define FAILED 2 /* operation failed for unexplained reason */
	122	#define MACHINE_UNKNOWN 3 /* caller's machine name unknown */
	123	#define PERMISSION_DENIED 4 /* callee's tty doesn't permit announce */
	124	#define UNKNOWN_REQUEST 5 /* request has invalid type value */
	125	#define BADVERSION 6 /* request has invalid protocol version */
	126	#define BADADDR 7 /* request has invalid addr value */
	127	#define BADCTLADDR 8 /* request has invalid ctl_addr value */
	128
	129	/*
	130	* Operational parameters.
	131	*/
	132	#define MAX_LIFE 60 /* max time daemon saves invitations */
	133	/* RING_WAIT should be 10's of seconds less than MAX_LIFE */
	134	#define RING_WAIT 30 /* time to wait before resending invitation */
	135
	136	#endif /* !_TALKD_H_ */