include/protocols/talkd.h

   1 /*
   2  * Copyright (c) 2000, 2006, 2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1983, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)talkd.h     8.1 (Berkeley) 6/2/93
  56  */
  57
  58 #ifndef _TALKD_H_
  59 #define _TALKD_H_
  60
  61 /*
  62  * This describes the protocol used by the talk server and clients.
  63  *
  64  * The talk server acts a repository of invitations, responding to
  65  * requests by clients wishing to rendezvous for the purpose of
  66  * holding a conversation.  In normal operation, a client, the caller,
  67  * initiates a rendezvous by sending a CTL_MSG to the server of
  68  * type LOOK_UP.  This causes the server to search its invitation
  69  * tables to check if an invitation currently exists for the caller
  70  * (to speak to the callee specified in the message).  If the lookup
  71  * fails, the caller then sends an ANNOUNCE message causing the server
  72  * to broadcast an announcement on the callee's login ports requesting
  73  * contact.  When the callee responds, the local server uses the
  74  * recorded invitation to respond with the appropriate rendezvous
  75  * address and the caller and callee client programs establish a
  76  * stream connection through which the conversation takes place.
  77  */
  78
  79 /*
  80  * 4.3 compat sockaddr
  81  */
  82 #include <_types.h>
  83 struct osockaddr {
  84         __uint16_t      sa_family;      /* address family */
  85         char            sa_data[14];    /* up to 14 bytes of direct address */
  86 };
  87
  88 /*
  89  * Client->server request message format.
  90  */
  91 typedef struct {
  92         unsigned char   vers;           /* protocol version */
  93         unsigned char   type;           /* request type, see below */
  94         unsigned char   answer;         /* not used */
  95         unsigned char   pad;
  96 #ifdef __LP64__
  97         unsigned int    id_num;         /* message id */
  98 #else /* !__LP64__ */
  99         unsigned long   id_num;         /* message id */
 100 #endif /* __LP64__ */
 101         struct          osockaddr addr;         /* old (4.3) style */
 102         struct          osockaddr ctl_addr;     /* old (4.3) style */
 103 #ifdef __LP64__
 104         int             pid;            /* caller's process id */
 105 #else /* !__LP64__ */
 106         long            pid;            /* caller's process id */
 107 #endif /* __LP64__ */
 108 #define NAME_SIZE       12
 109         char            l_name[NAME_SIZE];/* caller's name */
 110         char            r_name[NAME_SIZE];/* callee's name */
 111 #define TTY_SIZE        16
 112         char            r_tty[TTY_SIZE];/* callee's tty name */
 113 } CTL_MSG;
 114
 115 /*
 116  * Server->client response message format.
 117  */
 118 typedef struct {
 119         unsigned char   vers;           /* protocol version */
 120         unsigned char   type;           /* type of request message, see below */
 121         unsigned char   answer;         /* respose to request message, see below */
 122         unsigned char   pad;
 123 #ifdef __LP64__
 124         unsigned int    id_num;         /* message id */
 125 #else /* !__LP64__ */
 126         unsigned long   id_num;         /* message id */
 127 #endif /* __LP64__ */
 128         struct  osockaddr addr;         /* address for establishing conversation */
 129 } CTL_RESPONSE;
 130
 131 #define TALK_VERSION    1               /* protocol version */
 132
 133 /* message type values */
 134 #define LEAVE_INVITE    0       /* leave invitation with server */
 135 #define LOOK_UP         1       /* check for invitation by callee */
 136 #define DELETE          2       /* delete invitation by caller */
 137 #define ANNOUNCE        3       /* announce invitation by caller */
 138
 139 /* answer values */
 140 #define SUCCESS         0       /* operation completed properly */
 141 #define NOT_HERE        1       /* callee not logged in */
 142 #define FAILED          2       /* operation failed for unexplained reason */
 143 #define MACHINE_UNKNOWN 3       /* caller's machine name unknown */
 144 #define PERMISSION_DENIED 4     /* callee's tty doesn't permit announce */
 145 #define UNKNOWN_REQUEST 5       /* request has invalid type value */
 146 #define BADVERSION      6       /* request has invalid protocol version */
 147 #define BADADDR         7       /* request has invalid addr value */
 148 #define BADCTLADDR      8       /* request has invalid ctl_addr value */
 149
 150 /*
 151  * Operational parameters.
 152  */
 153 #define MAX_LIFE        60      /* max time daemon saves invitations */
 154 /* RING_WAIT should be 10's of seconds less than MAX_LIFE */
 155 #define RING_WAIT       30      /* time to wait before resending invitation */
 156
 157 #endif /* !_TALKD_H_ */