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