Annotation of XNU/bsd/include/protocols/talkd.h, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.