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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)talkd.h 8.1 (Berkeley) 6/2/93
30 */
31
32#ifndef _PROTOCOLS_TALKD_H
33#define _PROTOCOLS_TALKD_H 1
34
35/*
36 * This describes the protocol used by the talk server and clients.
37 *
38 * The talk server acts a repository of invitations, responding to
39 * requests by clients wishing to rendezvous for the purpose of
40 * holding a conversation. In normal operation, a client, the caller,
41 * initiates a rendezvous by sending a CTL_MSG to the server of
42 * type LOOK_UP. This causes the server to search its invitation
43 * tables to check if an invitation currently exists for the caller
44 * (to speak to the callee specified in the message). If the lookup
45 * fails, the caller then sends an ANNOUNCE message causing the server
46 * to broadcast an announcement on the callee's login ports requesting
47 * contact. When the callee responds, the local server uses the
48 * recorded invitation to respond with the appropriate rendezvous
49 * address and the caller and callee client programs establish a
50 * stream connection through which the conversation takes place.
51 */
52
53#include <sys/types.h>
54#include <sys/socket.h>
55#include <stdint.h>
56#include <bits/types/struct_osockaddr.h>
57
58/*
59 * Client->server request message format.
60 */
61typedef struct {
62 unsigned char vers; /* protocol version */
63 unsigned char type; /* request type, see below */
64 unsigned char answer; /* not used */
65 unsigned char pad;
66 uint32_t id_num; /* message id */
67 struct osockaddr addr; /* old (4.3) style */
68 struct osockaddr ctl_addr; /* old (4.3) style */
69 int32_t pid; /* caller's process id */
70#define NAME_SIZE 12
71 char l_name[NAME_SIZE];/* caller's name */
72 char r_name[NAME_SIZE];/* callee's name */
73#define TTY_SIZE 16
74 char r_tty[TTY_SIZE];/* callee's tty name */
75} CTL_MSG;
76
77/*
78 * Server->client response message format.
79 */
80typedef struct {
81 unsigned char vers; /* protocol version */
82 unsigned char type; /* type of request message, see below */
83 unsigned char answer; /* response to request message, see below */
84 unsigned char pad;
85 uint32_t id_num; /* message id */
86 struct osockaddr addr; /* address for establishing 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 /* protocols/talkd.h */