git.mutantstargoat.com Git - oftp/blob - libs/watt32/protocol/talkd.h

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