include/protocols/talkd.h

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