xref: /openbsd/include/protocols/talkd.h (revision 17df1aa7)
1 /*	$OpenBSD: talkd.h,v 1.4 2004/01/22 21:48:02 espie Exp $	*/
2 /*	$NetBSD: talkd.h,v 1.5 1995/03/04 07:59:30 cgd Exp $	*/
3 
4 /*
5  * Copyright (c) 1983 Regents of the University of California.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)talkd.h	5.7 (Berkeley) 4/3/91
33  */
34 
35 #ifndef _TALKD_H_
36 #define	_TALKD_H_
37 
38 /*
39  * This describes the protocol used by the talk server and clients.
40  *
41  * The talk server acts a repository of invitations, responding to
42  * requests by clients wishing to rendezvous for the purpose of
43  * holding a conversation.  In normal operation, a client, the caller,
44  * initiates a rendezvous by sending a CTL_MSG to the server of
45  * type LOOK_UP.  This causes the server to search its invitation
46  * tables to check if an invitation currently exists for the caller
47  * (to speak to the callee specified in the message).  If the lookup
48  * fails, the caller then sends an ANNOUNCE message causing the server
49  * to broadcast an announcement on the callee's login ports requesting
50  * contact.  When the callee responds, the local server uses the
51  * recorded invitation to respond with the appropriate rendezvous
52  * address and the caller and callee client programs establish a
53  * stream connection through which the conversation takes place.
54  */
55 
56 /*
57  * Client->server request message format.
58  */
59 typedef struct {
60 	unsigned char	  vers;			/* protocol version */
61 	unsigned char	  type;			/* request type, see below */
62 	unsigned char	  answer;		/* not used */
63 	unsigned char	  pad;
64 	u_int32_t 	  id_num;		/* message id */
65 	struct	  osockaddr addr;		/* old (4.3) style */
66 	struct	  osockaddr ctl_addr;		/* old (4.3) style */
67 	int32_t	  	  pid;			/* caller's process id */
68 #define	NAME_SIZE	12
69 	char	  	  l_name[NAME_SIZE];	/* caller's name */
70 	char	  	  r_name[NAME_SIZE];	/* callee's name */
71 #define	TTY_SIZE	16
72 	char	  	  r_tty[TTY_SIZE];	/* callee's tty name */
73 } CTL_MSG;
74 
75 /*
76  * Server->client response message format.
77  */
78 typedef struct {
79 	unsigned char	  vers;		/* protocol version */
80 	unsigned char	  type;		/* type of request message, see below */
81 	unsigned char	  answer;	/* response to request message,
82 					   see below */
83 	unsigned char	  pad;
84 	u_int32_t 	  id_num;	/* message id */
85 	struct	  osockaddr addr; 	/* address for establishing
86 					   conversation */
87 } CTL_RESPONSE;
88 
89 #define	TALK_VERSION	1		/* protocol version */
90 
91 /* message type values */
92 #define LEAVE_INVITE	0	/* leave invitation with server */
93 #define LOOK_UP		1	/* check for invitation by callee */
94 #define DELETE		2	/* delete invitation by caller */
95 #define ANNOUNCE	3	/* announce invitation by caller */
96 
97 /* answer values */
98 #define SUCCESS		0	/* operation completed properly */
99 #define NOT_HERE	1	/* callee not logged in */
100 #define FAILED		2	/* operation failed for unexplained reason */
101 #define MACHINE_UNKNOWN	3	/* caller's machine name unknown */
102 #define PERMISSION_DENIED 4	/* callee's tty doesn't permit announce */
103 #define UNKNOWN_REQUEST	5	/* request has invalid type value */
104 #define	BADVERSION	6	/* request has invalid protocol version */
105 #define	BADADDR		7	/* request has invalid addr value */
106 #define	BADCTLADDR	8	/* request has invalid ctl_addr value */
107 
108 /*
109  * Operational parameters.
110  */
111 #define MAX_LIFE	60	/* max time daemon saves invitations */
112 /* RING_WAIT should be 10's of seconds less than MAX_LIFE */
113 #define RING_WAIT	30	/* time to wait before resending invitation */
114 
115 #endif /* !_TALKD_H_ */
116