cde/lib/DtSvc/DtUtil2/Message.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these libraries and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /*
  24  * File:         Message.h $XConsortium: Message.h /main/5 1996/03/01 16:36:42 drk $
  25  * Language:     C
  26  *
  27  * (c) Copyright 1990, Hewlett-Packard Company, all rights reserved.
  28  *
  29  * (c) Copyright 1993, 1994 Hewlett-Packard Company                     *
  30  * (c) Copyright 1993, 1994 International Business Machines Corp.       *
  31  * (c) Copyright 1993, 1994 Sun Microsystems, Inc.                      *
  32  * (c) Copyright 1993, 1994 Novell, Inc.                                *
  33  */
  34
  35 #ifndef _Dt_message_h
  36 #define _Dt_message_h
  37
  38 #include <Dt/DataTypes.h>
  39 #include <Dt/DtP.h>
  40
  41 #include <Dt/Service.h>
  42
  43 /* This header file is a modifed version of <Xv/Message.h> that
  44  * provides compatibility between the BMS messaging and the new
  45  * ICCCM messaging used in DT.
  46  *
  47  * The following symbols that were defined in <Xv/Message.h> are
  48  * no longer available.  Any code that depended on them will have
  49  * to be rewritten:
  50  *
  51  *      DtServerDeathFn
  52  *      DtCloseMsgServerConnect
  53  *      DtAddFailNotificationCallback
  54  *      DtStatusResponse
  55  *      DtUniqueRequestId
  56  *      DtSendFailNotification
  57  *      DtSendMsg
  58  */
  59
  60
  61 /**********************************
  62  *
  63  * Message Format
  64  *
  65  **********************************/
  66
  67 /*
  68  * DT messages have the following format:
  69  *
  70  *      Request message:        <request> [args ...]
  71  *      Reply message:          <SUCCESS | FAILURE> [args ...]
  72  *      Notify message:         <notification> [args ...]
  73  *
  74  * The following fields in BMS messages are no longer supported:
  75  *
  76  *      DT_MSG_SENDER
  77  *      DT_MSG_REQUEST_ID
  78  *      DT_MSG_TOOL
  79  *      DT_MSG_HOST
  80  *      DT_MSG_DIR
  81  *      DT_MSG_FILE
  82  */
  83
  84 #define DT_MSG_TYPE             0
  85 #define DT_MSG_COMMAND          0
  86 #define DT_MSG_DATA_1           1
  87 #define DT_MSG_DATA_2           2
  88 #define DT_MSG_DATA_3           3
  89 #define DT_MSG_DATA_4           4
  90 #define DT_MSG_DATA_5           5
  91 #define DT_MSG_DATA_6           6
  92 #define DT_MSG_DATA_7           7
  93 #define DT_MSG_DATA_8           8
  94 #define DT_MSG_DATA_9           9
  95 #define DT_MSG_DATA_10          10
  96 #define DT_MSG_DATA_11          11
  97 #define DT_MSG_DATA_12          12
  98 #define DT_MSG_DATA_13          13
  99 #define DT_MSG_DATA_14          14
 100 #define DT_MSG_DATA_15          15
 101 #define DT_MSG_DATA_16          16
 102 #define DT_MSG_DATA_17          17
 103 #define DT_MSG_DATA_18          18
 104 #define DT_MSG_DATA_19          19
 105 #define DT_MSG_DATA_20          20
 106
 107 #define DtDONT_CARE_FIELD               "*"
 108 /*
 109         If a particular message does not require a value in one of the
 110         fields, use DtDONT_CARE_FIELD for the value of the field.
 111 */
 112
 113 #endif /*_Dt_message_h*/
 114 /* Do not add anything after this endif. */