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