Merge from vendor branch INTEL_ACPICA:
[dragonfly.git] / include / protocols / talkd.h
CommitLineData
984263bc
MD
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
9eee10d0 34 * $DragonFly: src/include/protocols/talkd.h,v 1.2 2003/09/12 00:43:30 daver Exp $
984263bc
MD
35 */
36
37#ifndef _PROTOCOLS_TALKD_H_
38#define _PROTOCOLS_TALKD_H_
39
40/*
41 * This describes the protocol used by the talk server and clients.
42 *
43 * The talk server acts a repository of invitations, responding to
44 * requests by clients wishing to rendezvous for the purpose of
45 * holding a conversation. In normal operation, a client, the caller,
46 * initiates a rendezvous by sending a CTL_MSG to the server of
47 * type LOOK_UP. This causes the server to search its invitation
48 * tables to check if an invitation currently exists for the caller
49 * (to speak to the callee specified in the message). If the lookup
50 * fails, the caller then sends an ANNOUNCE message causing the server
51 * to broadcast an announcement on the callee's login ports requesting
52 * contact. When the callee responds, the local server uses the
53 * recorded invitation to respond with the appropriate rendezvous
54 * address and the caller and callee client programs establish a
55 * stream connection through which the conversation takes place.
56 */
57
9eee10d0
DRJ
58/*
59 * XXX: Nothing should explicity reference the structure osockaddr.
60 * It is for binary compatibility only. The talk protocol doesn't
61 * understand this yet.
62 */
63struct osockaddr {
64 u_short sa_family;
65 char sa_data[14];
66};
67
984263bc
MD
68/*
69 * Client->server request message format.
70 */
71typedef struct {
72 u_char vers; /* protocol version */
73 u_char type; /* request type, see below */
74 u_char answer; /* not used */
75 u_char pad;
76 u_int32_t id_num; /* message id */
77 struct osockaddr addr; /* old (4.3) style */
78 struct osockaddr ctl_addr; /* old (4.3) style */
79 int32_t pid; /* caller's process id */
80#define NAME_SIZE 12
81 char l_name[NAME_SIZE];/* caller's name */
82 char r_name[NAME_SIZE];/* callee's name */
83#define TTY_SIZE 16
84 char r_tty[TTY_SIZE];/* callee's tty name */
85} CTL_MSG;
86
87/*
88 * Server->client response message format.
89 */
90typedef struct {
91 u_char vers; /* protocol version */
92 u_char type; /* type of request message, see below */
93 u_char answer; /* respose to request message, see below */
94 u_char pad;
95 u_int32_t id_num; /* message id */
96 struct osockaddr addr; /* address for establishing conversation */
97} CTL_RESPONSE;
98
99#define TALK_VERSION 1 /* protocol version */
100
101/* message type values */
102#define LEAVE_INVITE 0 /* leave invitation with server */
103#define LOOK_UP 1 /* check for invitation by callee */
104#define DELETE 2 /* delete invitation by caller */
105#define ANNOUNCE 3 /* announce invitation by caller */
106
107/* answer values */
108#define SUCCESS 0 /* operation completed properly */
109#define NOT_HERE 1 /* callee not logged in */
110#define FAILED 2 /* operation failed for unexplained reason */
111#define MACHINE_UNKNOWN 3 /* caller's machine name unknown */
112#define PERMISSION_DENIED 4 /* callee's tty doesn't permit announce */
113#define UNKNOWN_REQUEST 5 /* request has invalid type value */
114#define BADVERSION 6 /* request has invalid protocol version */
115#define BADADDR 7 /* request has invalid addr value */
116#define BADCTLADDR 8 /* request has invalid ctl_addr value */
117
118/*
119 * Operational parameters.
120 */
121#define MAX_LIFE 60 /* max time daemon saves invitations */
122/* RING_WAIT should be 10's of seconds less than MAX_LIFE */
123#define RING_WAIT 30 /* time to wait before resending invitation */
124
125#endif /* !_TALKD_H_ */