dcop

ICElib.h

00001 /* $XConsortium: ICElib.h /main/41 1996/11/29 13:30:19 swick $ */
00002 /* $XFree86: xc/lib/ICE/ICElib.h,v 3.1 1996/12/23 05:58:57 dawes Exp $ */
00003 /******************************************************************************
00004 
00005 
00006 Copyright (c) 1993  X Consortium
00007 
00008 Permission is hereby granted, free of charge, to any person obtaining a copy
00009 of this software and associated documentation files (the "Software"), to deal
00010 in the Software without restriction, including without limitation the rights
00011 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012 copies of the Software, and to permit persons to whom the Software is
00013 furnished to do so, subject to the following conditions:
00014 
00015 The above copyright notice and this permission notice shall be included in
00016 all copies or substantial portions of the Software.
00017 
00018 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
00021 X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
00022 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
00023 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00024 
00025 Except as contained in this notice, the name of the X Consortium shall not be
00026 used in advertising or otherwise to promote the sale, use or other dealings
00027 in this Software without prior written authorization from the X Consortium.
00028 
00029 Author: Ralph Mor, X Consortium
00030 ******************************************************************************/
00031 
00032 #ifndef _ICELIB_H_
00033 #define _ICELIB_H_
00034 
00035 #include <KDE-ICE/ICE.h>
00036 #include <KDE-ICE/Xfuncproto.h>
00037 #ifndef SIZEOF
00038 #define _SIZEOF(x) sz_##x
00039 #define SIZEOF(x) _SIZEOF(x)
00040 #endif
00041 
00042 #define Bool int
00043 #define Status int
00044 #define True 1
00045 #define False 0
00046 
00047 #if NeedFunctionPrototypes
00048 typedef void *IcePointer;
00049 #else
00050 typedef char *IcePointer;
00051 #endif
00052 
00053 typedef enum {
00054     IcePoAuthHaveReply,
00055     IcePoAuthRejected,
00056     IcePoAuthFailed,
00057     IcePoAuthDoneCleanup
00058 } IcePoAuthStatus;
00059 
00060 typedef enum {
00061     IcePaAuthContinue,
00062     IcePaAuthAccepted,
00063     IcePaAuthRejected,
00064     IcePaAuthFailed
00065 } IcePaAuthStatus;
00066 
00067 typedef enum {
00068     IceConnectPending,
00069     IceConnectAccepted,
00070     IceConnectRejected,
00071     IceConnectIOError
00072 } IceConnectStatus;
00073 
00074 typedef enum {
00075     IceProtocolSetupSuccess,
00076     IceProtocolSetupFailure,
00077     IceProtocolSetupIOError,
00078     IceProtocolAlreadyActive
00079 } IceProtocolSetupStatus;
00080 
00081 typedef enum {
00082     IceAcceptSuccess,
00083     IceAcceptFailure,
00084     IceAcceptBadMalloc
00085 } IceAcceptStatus;
00086 
00087 typedef enum {
00088     IceClosedNow,
00089     IceClosedASAP,
00090     IceConnectionInUse,
00091     IceStartedShutdownNegotiation
00092 } IceCloseStatus;
00093 
00094 typedef enum {
00095     IceProcessMessagesSuccess,
00096     IceProcessMessagesIOError,
00097     IceProcessMessagesConnectionClosed
00098 } IceProcessMessagesStatus;
00099 
00100 typedef struct {
00101     unsigned long   sequence_of_request;
00102     int         major_opcode_of_request;
00103     int         minor_opcode_of_request;
00104     IcePointer      reply;
00105 } IceReplyWaitInfo;
00106 
00107 typedef struct _IceConn *IceConn;
00108 typedef struct _IceListenObj *IceListenObj;
00109 
00110 typedef void (*IceWatchProc) (
00111 #if NeedFunctionPrototypes
00112     IceConn     /* iceConn */,
00113     IcePointer      /* clientData */,
00114     Bool        /* opening */,
00115     IcePointer *    /* watchData */
00116 #endif
00117 );
00118 
00119 typedef void (*IcePoProcessMsgProc) (
00120 #if NeedFunctionPrototypes
00121     IceConn         /* iceConn */,
00122     IcePointer      /* clientData */,
00123     int         /* opcode */,
00124     unsigned long   /* length */,
00125     Bool        /* swap */,
00126     IceReplyWaitInfo *  /* replyWait */,
00127     Bool *      /* replyReadyRet */
00128 #endif
00129 );
00130 
00131 typedef void (*IcePaProcessMsgProc) (
00132 #if NeedFunctionPrototypes
00133     IceConn         /* iceConn */,
00134     IcePointer      /* clientData */,
00135     int         /* opcode */,
00136     unsigned long   /* length */,
00137     Bool        /* swap */
00138 #endif
00139 );
00140 
00141 typedef struct {
00142     int          major_version;
00143     int          minor_version;
00144     IcePoProcessMsgProc  process_msg_proc;
00145 } IcePoVersionRec;
00146 
00147 typedef struct {
00148     int          major_version;
00149     int          minor_version;
00150     IcePaProcessMsgProc  process_msg_proc;
00151 } IcePaVersionRec;
00152 
00153 typedef IcePoAuthStatus (*IcePoAuthProc) (
00154 #if NeedFunctionPrototypes
00155     IceConn     /* iceConn */,
00156     IcePointer *    /* authStatePtr */,
00157     Bool        /* cleanUp */,
00158     Bool        /* swap */,
00159     int         /* authDataLen */,
00160     IcePointer      /* authData */,
00161     int *       /* replyDataLenRet */,
00162     IcePointer *    /* replyDataRet */,
00163     char **     /* errorStringRet */
00164 #endif
00165 );
00166 
00167 typedef IcePaAuthStatus (*IcePaAuthProc) (
00168 #if NeedFunctionPrototypes
00169     IceConn     /* iceConn */,
00170     IcePointer *    /* authStatePtr */,
00171     Bool        /* swap */,
00172     int         /* authDataLen */,
00173     IcePointer      /* authData */,
00174     int *       /* replyDataLenRet */,
00175     IcePointer *    /* replyDataRet */,
00176     char **     /* errorStringRet */
00177 #endif
00178 );
00179 
00180 typedef Bool (*IceHostBasedAuthProc) (
00181 #if NeedFunctionPrototypes
00182     char *      /* hostName */
00183 #endif
00184 );
00185 
00186 typedef Status (*IceProtocolSetupProc) (
00187 #if NeedFunctionPrototypes
00188     IceConn         /* iceConn */,
00189     int         /* majorVersion */,
00190     int         /* minorVersion */,
00191     char *      /* vendor */,
00192     char *      /* release */,
00193     IcePointer *    /* clientDataRet */,
00194     char **     /* failureReasonRet */
00195 #endif
00196 );
00197 
00198 typedef void (*IceProtocolActivateProc) (
00199 #if NeedFunctionPrototypes
00200     IceConn         /* iceConn */,
00201     IcePointer      /* clientData */
00202 #endif
00203 );
00204 
00205 typedef void (*IceWriteHandler) (
00206 #if NeedFunctionPrototypes
00207     IceConn         /* iceConn */,
00208     unsigned long   /* nbytes */,
00209     char *              /* ptr */
00210 #endif
00211 );
00212 
00213 typedef void (*IceIOErrorProc) (
00214 #if NeedFunctionPrototypes
00215     IceConn         /* iceConn */
00216 #endif
00217 );
00218 
00219 typedef void (*IcePingReplyProc) (
00220 #if NeedFunctionPrototypes
00221     IceConn         /* iceConn */,
00222     IcePointer      /* clientData */
00223 #endif
00224 );
00225 
00226 typedef void (*IceErrorHandler) (
00227 #if NeedFunctionPrototypes
00228     IceConn         /* iceConn */,
00229     Bool        /* swap */,
00230     int         /* offendingMinorOpcode */,
00231     unsigned long   /* offendingSequence */,
00232     int         /* errorClass */,
00233     int         /* severity */,
00234     IcePointer      /* values */
00235 #endif
00236 );
00237 
00238 typedef void (*IceIOErrorHandler) (
00239 #if NeedFunctionPrototypes
00240     IceConn         /* iceConn */
00241 #endif
00242 );
00243 
00244 
00245 /*
00246  * Function prototypes
00247  */
00248 
00249 _XFUNCPROTOBEGIN
00250 
00251 #define IceRegisterForProtocolSetup KDE_IceRegisterForProtocolSetup
00252 
00253 extern int IceRegisterForProtocolSetup (
00254 #if NeedFunctionPrototypes
00255     char *          /* protocolName */,
00256     char *          /* vendor */,
00257     char *          /* release */,
00258     int             /* versionCount */,
00259     IcePoVersionRec *       /* versionRecs */,
00260     int             /* authCount */,
00261     char **         /* authNames */,
00262     IcePoAuthProc *     /* authProcs */,
00263     IceIOErrorProc      /* IOErrorProc */
00264 #endif
00265 );
00266 
00267 #define IceRegisterForProtocolReply KDE_IceRegisterForProtocolReply
00268 
00269 extern int IceRegisterForProtocolReply (
00270 #if NeedFunctionPrototypes
00271     char *          /* protocolName */,
00272     char *          /* vendor */,
00273     char *          /* release */,
00274     int             /* versionCount */,
00275     IcePaVersionRec *       /* versionRecs */,
00276     int             /* authCount */,
00277     char **         /* authNames */,
00278     IcePaAuthProc *     /* authProcs */,
00279     IceHostBasedAuthProc    /* hostBasedAuthProc */,
00280     IceProtocolSetupProc    /* protocolSetupProc */,
00281     IceProtocolActivateProc /* protocolActivateProc */,
00282     IceIOErrorProc      /* IOErrorProc */
00283 #endif
00284 );
00285 
00286 #define IceOpenConnection KDE_IceOpenConnection
00287 
00288 extern IceConn IceOpenConnection (
00289 #if NeedFunctionPrototypes
00290     char *      /* networkIdsList */,
00291     IcePointer      /* context */,
00292     Bool        /* mustAuthenticate */,
00293     int         /* majorOpcodeCheck */,
00294     int         /* errorLength */,
00295     char *      /* errorStringRet */
00296 #endif
00297 );
00298 
00299 #define IceGetConnectionContext KDE_IceGetConnectionContext
00300 
00301 extern IcePointer IceGetConnectionContext (
00302 #if NeedFunctionPrototypes
00303     IceConn     /* iceConn */
00304 #endif
00305 );
00306 
00307 #define IceListenForConnections KDE_IceListenForConnections
00308 
00309 extern Status IceListenForConnections (
00310 #if NeedFunctionPrototypes
00311     int *       /* countRet */,
00312     IceListenObj ** /* listenObjsRet */,
00313     int         /* errorLength */,
00314     char *      /* errorStringRet */
00315 #endif
00316 );
00317 
00318 #define IceListenForWellKnownConnections KDE_IceListenForWellKnownConnections
00319 
00320 extern Status IceListenForWellKnownConnections (
00321 #if NeedFunctionPrototypes
00322     char *      /* port */,
00323     int *       /* countRet */,
00324     IceListenObj ** /* listenObjsRet */,
00325     int         /* errorLength */,
00326     char *      /* errorStringRet */
00327 #endif
00328 );
00329 
00330 #define IceGetListenConnectionNumber KDE_IceGetListenConnectionNumber
00331 
00332 extern int IceGetListenConnectionNumber (
00333 #if NeedFunctionPrototypes
00334     IceListenObj    /* listenObj */
00335 #endif
00336 );
00337 
00338 #define IceGetListenConnectionString KDE_IceGetListenConnectionString
00339 
00340 extern char *IceGetListenConnectionString (
00341 #if NeedFunctionPrototypes
00342     IceListenObj    /* listenObj */
00343 #endif
00344 );
00345 
00346 #define IceComposeNetworkIdList KDE_IceComposeNetworkIdList
00347 
00348 extern char *IceComposeNetworkIdList (
00349 #if NeedFunctionPrototypes
00350     int         /* count */,
00351     IceListenObj *  /* listenObjs */
00352 #endif
00353 );
00354 
00355 #define IceFreeListenObjs KDE_IceFreeListenObjs
00356 
00357 extern void IceFreeListenObjs (
00358 #if NeedFunctionPrototypes
00359     int         /* count */,
00360     IceListenObj *  /* listenObjs */
00361 #endif
00362 );
00363 
00364 #define IceSetHostBasedAuthProc KDE_IceSetHostBasedAuthProc
00365 
00366 extern void IceSetHostBasedAuthProc (
00367 #if NeedFunctionPrototypes
00368     IceListenObj        /* listenObj */,
00369     IceHostBasedAuthProc    /* hostBasedAuthProc */
00370 #endif
00371 );
00372 
00373 #define IceAcceptConnection KDE_IceAcceptConnection
00374 
00375 extern IceConn IceAcceptConnection (
00376 #if NeedFunctionPrototypes
00377     IceListenObj    /* listenObj */,
00378     IceAcceptStatus *   /* statusRet */
00379 #endif
00380 );
00381 
00382 #define IceSetShutdownNegotiation KDE_IceSetShutdownNegotiation
00383 
00384 extern void IceSetShutdownNegotiation (
00385 #if NeedFunctionPrototypes
00386     IceConn     /* iceConn */,
00387     Bool        /* negotiate */
00388 #endif
00389 );
00390 
00391 #define IceCheckShutdownNegotiation KDE_IceCheckShutdownNegotiation
00392 
00393 extern Bool IceCheckShutdownNegotiation (
00394 #if NeedFunctionPrototypes
00395     IceConn     /* iceConn */
00396 #endif
00397 );
00398 
00399 #define IceCloseConnection KDE_IceCloseConnection
00400 
00401 extern IceCloseStatus IceCloseConnection (
00402 #if NeedFunctionPrototypes
00403     IceConn     /* iceConn */
00404 #endif
00405 );
00406 
00407 #define IceAddConnectionWatch KDE_IceAddConnectionWatch
00408 
00409 extern Status IceAddConnectionWatch (
00410 #if NeedFunctionPrototypes
00411     IceWatchProc        /* watchProc */,
00412     IcePointer          /* clientData */
00413 #endif
00414 );
00415 
00416 #define IceRemoveConnectionWatch KDE_IceRemoveConnectionWatch
00417 
00418 extern void IceRemoveConnectionWatch (
00419 #if NeedFunctionPrototypes
00420     IceWatchProc        /* watchProc */,
00421     IcePointer          /* clientData */
00422 #endif
00423 );
00424 
00425 #define IceProtocolSetup KDE_IceProtocolSetup
00426 
00427 extern IceProtocolSetupStatus IceProtocolSetup (
00428 #if NeedFunctionPrototypes
00429     IceConn     /* iceConn */,
00430     int         /* myOpcode */,
00431     IcePointer      /* clientData */,
00432     Bool        /* mustAuthenticate */,
00433     int *       /* majorVersionRet */,
00434     int *       /* minorVersionRet */,
00435     char **     /* vendorRet */,
00436     char **     /* releaseRet */,
00437     int         /* errorLength */,
00438     char *      /* errorStringRet */
00439 #endif
00440 );
00441 
00442 #define IceProtocolShutdown KDE_IceProtocolShutdown
00443 
00444 extern Status IceProtocolShutdown (
00445 #if NeedFunctionPrototypes
00446     IceConn     /* iceConn */,
00447     int         /* majorOpcode */
00448 #endif
00449 );
00450 
00451 #define IceProcessMessages KDE_IceProcessMessages
00452 
00453 extern IceProcessMessagesStatus IceProcessMessages (
00454 #if NeedFunctionPrototypes
00455     IceConn     /* iceConn */,
00456     IceReplyWaitInfo *  /* replyWait */,
00457     Bool *      /* replyReadyRet */
00458 #endif
00459 );
00460 
00461 #define IcePing KDE_IcePing
00462 
00463 extern Status IcePing (
00464 #if NeedFunctionPrototypes
00465    IceConn      /* iceConn */,
00466    IcePingReplyProc /* pingReplyProc */,
00467    IcePointer       /* clientData */
00468 #endif
00469 );
00470 
00471 #define IceAllocScratch KDE_IceAllocScratch
00472 
00473 extern char *IceAllocScratch (
00474 #if NeedFunctionPrototypes
00475    IceConn      /* iceConn */,
00476    unsigned long    /* size */
00477 #endif
00478 );
00479 
00480 #define IceFlush KDE_IceFlush
00481 
00482 extern void IceFlush (
00483 #if NeedFunctionPrototypes
00484    IceConn      /* iceConn */
00485 #endif
00486 );
00487 
00488 #define IceGetOutBufSize KDE_IceGetOutBufSize
00489 
00490 extern int IceGetOutBufSize (
00491 #if NeedFunctionPrototypes
00492    IceConn      /* iceConn */
00493 #endif
00494 );
00495 
00496 #define IceGetInBufSize KDE_IceGetInBufSize
00497 
00498 extern int IceGetInBufSize (
00499 #if NeedFunctionPrototypes
00500    IceConn      /* iceConn */
00501 #endif
00502 );
00503 
00504 #define IceConnectionStatus KDE_IceConnectionStatus
00505 
00506 extern IceConnectStatus IceConnectionStatus (
00507 #if NeedFunctionPrototypes
00508     IceConn     /* iceConn */
00509 #endif
00510 );
00511 
00512 #define IceVendor KDE_IceVendor
00513 
00514 extern char *IceVendor (
00515 #if NeedFunctionPrototypes
00516     IceConn     /* iceConn */
00517 #endif
00518 );
00519 
00520 #define IceRelease KDE_IceRelease
00521 
00522 extern char *IceRelease (
00523 #if NeedFunctionPrototypes
00524     IceConn     /* iceConn */
00525 #endif
00526 );
00527 
00528 #define IceProtocolVersion KDE_IceProtocolVersion
00529 
00530 extern int IceProtocolVersion (
00531 #if NeedFunctionPrototypes
00532     IceConn     /* iceConn */
00533 #endif
00534 );
00535 
00536 #define IceProtocolRevision KDE_IceProtocolRevision
00537 
00538 extern int IceProtocolRevision (
00539 #if NeedFunctionPrototypes
00540     IceConn     /* iceConn */
00541 #endif
00542 );
00543 
00544 #define IceConnectionNumber KDE_IceConnectionNumber
00545 
00546 extern int IceConnectionNumber (
00547 #if NeedFunctionPrototypes
00548     IceConn     /* iceConn */
00549 #endif
00550 );
00551 
00552 #define IceConnectionString KDE_IceConnectionString
00553 
00554 extern char *IceConnectionString (
00555 #if NeedFunctionPrototypes
00556     IceConn     /* iceConn */
00557 #endif
00558 );
00559 
00560 #define IceLastSentSequenceNumber KDE_IceLastSentSequenceNumber
00561 
00562 extern unsigned long IceLastSentSequenceNumber (
00563 #if NeedFunctionPrototypes
00564     IceConn     /* iceConn */
00565 #endif
00566 );
00567 
00568 #define IceLastReceivedSequenceNumber KDE_IceLastReceivedSequenceNumber
00569 
00570 extern unsigned long IceLastReceivedSequenceNumber (
00571 #if NeedFunctionPrototypes
00572     IceConn     /* iceConn */
00573 #endif
00574 );
00575 
00576 #define IceSwapping KDE_IceSwapping
00577 
00578 extern Bool IceSwapping (
00579 #if NeedFunctionPrototypes
00580     IceConn     /* iceConn */
00581 #endif
00582 );
00583 
00584 #define IceSetErrorHandler KDE_IceSetErrorHandler
00585 
00586 extern IceErrorHandler IceSetErrorHandler (
00587 #if NeedFunctionPrototypes
00588     IceErrorHandler     /* handler */
00589 #endif
00590 );
00591 
00592 #define IceSetIOErrorHandler KDE_IceSetIOErrorHandler
00593 
00594 extern IceIOErrorHandler IceSetIOErrorHandler (
00595 #if NeedFunctionPrototypes
00596     IceIOErrorHandler   /* handler */
00597 #endif
00598 );
00599 
00600 
00601 /*
00602  * Multithread Routines
00603  */
00604 
00605 #define IceInitThreads KDE_IceInitThreads
00606 
00607 extern Status IceInitThreads (
00608 #if NeedFunctionPrototypes
00609     void
00610 #endif
00611 );
00612 
00613 #define IceAppLockConn KDE_IceAppLockConn
00614 
00615 extern void IceAppLockConn (
00616 #if NeedFunctionPrototypes
00617     IceConn     /* iceConn */
00618 #endif
00619 );
00620 
00621 #define IceAppUnlockConn KDE_IceAppUnlockConn
00622 
00623 extern void IceAppUnlockConn (
00624 #if NeedFunctionPrototypes
00625     IceConn     /* iceConn */
00626 #endif
00627 );
00628 
00629 _XFUNCPROTOEND
00630 
00631 #endif /* _ICELIB_H_ */
dcop

ICElib.h

dcop

API Reference
