WINGs/WUtil.h

   1 #ifndef _WUTIL_H_
   2 #define _WUTIL_H_
   3
   4 #include <X11/Xlib.h>
   5 #include <limits.h>
   6 #include <sys/types.h>
   7
   8 /* SunOS 4.x Blargh.... */
   9 #ifndef NULL
  10 #define NULL ((void*)0)
  11 #endif
  12
  13 /*
  14  * Warning: proplist.h #defines BOOL which will clash with the
  15  * typedef BOOL in Xmd.h
  16  * proplist.h should use Bool (which is a #define in Xlib.h) instead.
  17  *
  18  */
  19 #include <proplist.h>
  20
  21
  22 #ifndef WMAX
  23 # define WMAX(a,b)      ((a)>(b) ? (a) : (b))
  24 #endif
  25 #ifndef WMIN
  26 # define WMIN(a,b)      ((a)<(b) ? (a) : (b))
  27 #endif
  28
  29
  30 #if (!defined (__GNUC__) || __GNUC__ < 2 || \
  31      __GNUC_MINOR__ < (defined (__cplusplus) ? 6 : 4))
  32 #define __ASSERT_FUNCTION       ((char *) 0)
  33 #else
  34 #define __ASSERT_FUNCTION       __PRETTY_FUNCTION__
  35 #endif
  36
  37
  38 #ifdef NDEBUG
  39
  40 #define wassertr(expr)          {}
  41 #define wassertrv(expr, val)    {}
  42
  43 #else /* !NDEBUG */
  44
  45 #ifdef DEBUG
  46
  47 #include <assert.h>
  48
  49 #define wassertr(expr)  assert(expr)
  50
  51 #define wassertrv(expr, val)    assert(expr)
  52
  53 #else /* !DEBUG */
  54
  55 #define wassertr(expr) \
  56         if (!(expr)) { \
  57                 wwarning("%s line %i (%s): assertion %s failed",\
  58                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  59                 return;\
  60         }
  61
  62 #define wassertrv(expr, val) \
  63         if (!(expr)) { \
  64                 wwarning("%s line %i (%s): assertion %s failed",\
  65                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  66                 return (val);\
  67         }
  68 #endif /* !DEBUG */
  69
  70 #endif /* !NDEBUG */
  71
  72
  73 #ifdef __cplusplus
  74 extern "C" {
  75 #endif /* __cplusplus */
  76
  77
  78 typedef enum {
  79     WMPostWhenIdle = 1,
  80         WMPostASAP = 2,
  81         WMPostNow = 3
  82 } WMPostingStyle;
  83
  84
  85 typedef enum {
  86     WNCNone = 0,
  87         WNCOnName = 1,
  88         WNCOnSender = 2
  89 } WMNotificationCoalescing;
  90
  91
  92 /* The possible states for connections */
  93 typedef enum {
  94     WCNotConnected=0,
  95     WCListening,
  96     WCInProgress,
  97     WCFailed,
  98     WCConnected,
  99     WCTimedOut,
 100     WCDied,
 101     WCClosed
 102 } WMConnectionState;
 103
 104
 105 /* The possible states for connection timeouts */
 106 typedef enum {
 107     WCTNone=0,
 108     WCTWhileOpening,
 109     WCTWhileSending
 110 } WMConnectionTimeoutState;
 111
 112
 113
 114 enum {
 115     WBNotFound = INT_MIN /* element was not found in bag */
 116 };
 117
 118
 119 typedef struct W_Array WMArray;
 120 typedef struct W_Bag WMBag;
 121 typedef struct W_Data WMData;
 122 typedef struct W_HashTable WMHashTable;
 123 typedef struct W_UserDefaults WMUserDefaults;
 124 typedef struct W_Notification WMNotification;
 125 typedef struct W_NotificationQueue WMNotificationQueue;
 126 typedef struct W_Host WMHost;
 127 typedef struct W_Connection WMConnection;
 128
 129
 130
 131 typedef void WMFreeDataProc(void *data);
 132
 133
 134
 135 typedef struct {
 136     int position;
 137     int count;
 138 } WMRange;
 139
 140
 141
 142 /* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
 143 typedef struct {
 144     void *table;
 145     void *nextItem;
 146     int index;
 147 } WMHashEnumerator;
 148
 149
 150 typedef struct {
 151     /* NULL is pointer hash */
 152     unsigned    (*hash)(const void *);
 153     /* NULL is pointer compare */
 154     Bool        (*keyIsEqual)(const void *, const void *);
 155     /* NULL does nothing */
 156     void*       (*retainKey)(const void *);
 157     /* NULL does nothing */
 158     void        (*releaseKey)(const void *);
 159 } WMHashTableCallbacks;
 160
 161
 162 typedef void *WMBagIterator;
 163
 164 typedef struct W_BagFunctions {
 165     int (*getItemCount)(WMBag *self);
 166     int (*appendBag)(WMBag *self, WMBag *bag);
 167     int (*putInBag)(WMBag *self, void *item);
 168     int (*insertInBag)(WMBag *self, int index, void *item);
 169     int (*removeFromBag)(WMBag *bag, void *item);
 170     int (*eraseFromBag)(WMBag *bag, int index);
 171     int (*deleteFromBag)(WMBag *bag, int index);
 172     void *(*getFromBag)(WMBag *bag, int index);
 173     int (*firstInBag)(WMBag *bag, void *item);
 174     int (*countInBag)(WMBag *bag, void *item);
 175     void *(*replaceInBag)(WMBag *bag, int index, void *item);
 176     int (*sortBag)(WMBag *bag, int (*comparer)(const void*, const void*));
 177     void (*emptyBag)(WMBag *bag);
 178     void (*freeBag)(WMBag *bag);
 179     void (*mapBag)(WMBag *bag, void (*function)(void*, void*), void *data);
 180     int (*findInBag)(WMBag *bag, int (*match)(void*, void*), void *cdata);
 181     void *(*first)(WMBag *bag, WMBagIterator *ptr);
 182     void *(*last)(WMBag *bag, WMBagIterator *ptr);
 183     void *(*next)(WMBag *bag, WMBagIterator *ptr);
 184     void *(*previous)(WMBag *bag, WMBagIterator *ptr);
 185     void *(*iteratorAtIndex)(WMBag *bag, int index, WMBagIterator *ptr);
 186     int (*indexForIterator)(WMBag *bag, WMBagIterator ptr);
 187 } W_BagFunctions;
 188
 189
 190 struct W_Bag {
 191     void *data;
 192
 193     void (*destructor)(void *item);
 194
 195     W_BagFunctions func;
 196 };
 197
 198
 199
 200 #if 0
 201 typedef struct {
 202     char character;                    /* the escape character */
 203     char *value;                       /* value to place */
 204 } WMSEscapes;
 205 #endif
 206
 207
 208 /* The connection callbacks */
 209 typedef struct ConnectionDelegate {
 210     void *data;
 211
 212     void (*didCatchException)(struct ConnectionDelegate *self,
 213                               WMConnection *cPtr);
 214
 215     void (*didDie)(struct ConnectionDelegate *self, WMConnection *cPtr);
 216
 217     void (*didInitialize)(struct ConnectionDelegate *self, WMConnection *cPtr);
 218
 219     void (*didReceiveInput)(struct ConnectionDelegate *self, WMConnection *cPtr);
 220
 221     void (*didTimeout)(struct ConnectionDelegate *self, WMConnection *cPtr);
 222
 223 } ConnectionDelegate;
 224
 225
 226 typedef void WMNotificationObserverAction(void *observerData,
 227                                           WMNotification *notification);
 228
 229
 230
 231 /*......................................................................*/
 232
 233 typedef void (waborthandler)(int);
 234
 235 waborthandler *wsetabort(waborthandler*);
 236
 237
 238 /* don't free the returned string */
 239 char *wstrerror(int errnum);
 240
 241 void wfatal(const char *msg, ...);
 242 void wwarning(const char *msg, ...);
 243 void wsyserror(const char *msg, ...);
 244 void wsyserrorwithcode(int error, const char *msg, ...);
 245
 246 char *wfindfile(char *paths, char *file);
 247
 248 char *wfindfileinlist(char **path_list, char *file);
 249
 250 char *wfindfileinarray(proplist_t array, char *file);
 251
 252 char *wexpandpath(char *path);
 253
 254 /* don't free the returned string */
 255 char *wgethomedir();
 256
 257 void *wmalloc(size_t size);
 258 void *wrealloc(void *ptr, size_t newsize);
 259 void wfree(void *ptr);
 260
 261
 262 void wrelease(void *ptr);
 263 void *wretain(void *ptr);
 264
 265 char *wstrdup(char *str);
 266
 267 char *wstrappend(char *dst, char *src);
 268
 269
 270
 271
 272 void wtokensplit(char *command, char ***argv, int *argc);
 273
 274 char *wtokenjoin(char **list, int count);
 275
 276 void wtokenfree(char **tokens, int count);
 277
 278 char *wtrimspace(char *s);
 279
 280
 281
 282
 283 char *wusergnusteppath();
 284
 285 char *wdefaultspathfordomain(char *domain);
 286
 287 void wusleep(unsigned int microsec);
 288
 289 #if 0
 290 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 291                int count);
 292 #endif
 293
 294 /*......................................................................*/
 295
 296 /* This function is used _only_ if you create a NON-GUI program.
 297  * For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
 298  * This function will handle all input/timer/idle events, then return.
 299  */
 300
 301 void WHandleEvents();
 302
 303 /*......................................................................*/
 304
 305
 306 WMHashTable *WMCreateHashTable(WMHashTableCallbacks callbacks);
 307
 308 void WMFreeHashTable(WMHashTable *table);
 309
 310 void WMResetHashTable(WMHashTable *table);
 311
 312 void *WMHashGet(WMHashTable *table, const void *key);
 313
 314 /* put data in table, replacing already existing data and returning
 315  * the old value */
 316 void *WMHashInsert(WMHashTable *table, void *key, void *data);
 317
 318 void WMHashRemove(WMHashTable *table, const void *key);
 319
 320 /* warning: do not manipulate the table while using these functions */
 321 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 322
 323 void *WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 324
 325 unsigned WMCountHashTable(WMHashTable *table);
 326
 327
 328
 329
 330 /* some predefined callback sets */
 331
 332 extern const WMHashTableCallbacks WMIntHashCallbacks;
 333 /* sizeof(keys) are <= sizeof(void*) */
 334
 335 extern const WMHashTableCallbacks WMStringHashCallbacks;
 336 /* keys are strings. Strings will be copied with wstrdup()
 337  * and freed with wfree() */
 338
 339 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 340 /* keys are strings, bug they are not copied */
 341
 342
 343 /*......................................................................*/
 344
 345
 346 /*
 347  * Array bags use an array to store the elements.
 348  * Item indexes may be any integer number.
 349  *
 350  * Pros:
 351  * Fast [O(1)] access to elements
 352  * Fast [O(1)] push/pop
 353  *
 354  * Cons:
 355  * A little slower [O(n)] for insertion/deletion of elements that
 356  *      aren't in the end
 357  * Element indexes with large difference will cause large holes
 358  */
 359 #if 0
 360 WMBag* WMCreateArrayBag(int initialSize);
 361 WMBag* WMCreateArrayBagWithDestructor(int initialSize,
 362                                       void (*destructor)(void*));
 363 #endif
 364 /*
 365  * Tree bags use a red-black tree for storage.
 366  * Item indexes may be any integer number.
 367  *
 368  * Pros:
 369  * O(lg n) insertion/deletion/search
 370  * Good for large numbers of elements with sparse indexes
 371  *
 372  * Cons:
 373  * O(lg n) insertion/deletion/search
 374  * Slow for storing small numbers of elements
 375  */
 376 WMBag *WMCreateTreeBag(void);
 377 WMBag *WMCreateTreeBagWithDestructor(void (*destructor)(void*));
 378
 379
 380 #define WMCreateArrayBag(a) WMCreateTreeBag()
 381 #define WMCreateArrayBagWithDestructor(a,d) WMCreateTreeBagWithDestructor(d)
 382
 383 #define WMCreateBag(size) WMCreateTreeBag()
 384
 385 #define WMCreateBagWithDestructor(size, d) WMCreateTreeBagWithDestructor(d)
 386
 387 #define WMGetBagItemCount(bag) bag->func.getItemCount(bag)
 388
 389 #define WMAppendBag(bag, other) bag->func.appendBag(bag, other)
 390
 391 #define WMPutInBag(bag, item) bag->func.putInBag(bag, item)
 392
 393 /* insert will increment the index of elements after it by 1 */
 394 #define WMInsertInBag(bag, index, item) bag->func.insertInBag(bag, index, item)
 395
 396 /* this is slow */
 397 /* erase will remove the element from the bag,
 398  * but will keep the index of the other elements unchanged */
 399 #define WMEraseFromBag(bag, index) bag->func.eraseFromBag(bag, index)
 400
 401 /* delete and remove will remove the elements and cause the elements
 402  * after them to decrement their indexes by 1 */
 403 #define WMRemoveFromBag(bag, item) bag->func.removeFromBag(bag, item)
 404
 405 #define WMDeleteFromBag(bag, index) bag->func.deleteFromBag(bag, index)
 406
 407 #define WMGetFromBag(bag, index) bag->func.getFromBag(bag, index)
 408
 409 #define WMCountInBag(bag, item) bag->func.countInBag(bag, item)
 410
 411 #define WMReplaceInBag(bag, index, item) bag->func.replaceInBag(bag, index, item)
 412 #define WMSetInBag(bag, index, item) bag->func.replaceInBag(bag, index, item)
 413
 414 /* comparer must return:
 415  * < 0 if a < b
 416  * > 0 if a > b
 417  * = 0 if a = b
 418  */
 419 #define WMSortBag(bag, comparer) bag->func.sortBag(bag, comparer)
 420
 421 #define WMEmptyBag(bag) bag->func.emptyBag(bag)
 422
 423 #define WMFreeBag(bag) bag->func.freeBag(bag)
 424
 425 #define WMMapBag(bag, function, cdata) bag->func.mapBag(bag, function, cdata)
 426
 427 #define WMGetFirstInBag(bag, item) bag->func.firstInBag(bag, item)
 428
 429 #define WMCountInBag(bag, item) bag->func.countInBag(bag, item)
 430
 431 #define WMFindInBag(bag, match, cdata) bag->func.findInBag(bag, match, cdata)
 432
 433 #define WMBagFirst(bag, ptr) bag->func.first(bag, ptr)
 434
 435 #define WMBagLast(bag, ptr) bag->func.last(bag, ptr)
 436
 437 #define WMBagNext(bag, ptr) bag->func.next(bag, ptr)
 438
 439 #define WMBagPrevious(bag, ptr) bag->func.previous(bag, ptr)
 440
 441 #define WMBagIteratorAtIndex(bag, index, ptr) bag->func.iteratorAtIndex(bag, index, ptr)
 442
 443 #define WMBagIndexForIterator(bag, ptr) bag->func.indexForIterator(bag, ptr)
 444
 445
 446
 447 #define WM_ITERATE_BAG(bag, var, i) \
 448         for (var = WMBagFirst(bag, &(i)); (i) != NULL; \
 449                 var = WMBagNext(bag, &(i)))
 450
 451 #define WM_ETARETI_BAG(bag, var, i) \
 452         for (var = WMBagLast(bag, &(i)); (i) != NULL; \
 453                 var = WMBagPrevious(bag, &(i)))
 454
 455
 456
 457 /*-------------------------------------------------------------------------*/
 458
 459 /* WMData handling */
 460
 461 /* Creating/destroying data */
 462
 463 WMData* WMCreateDataWithCapacity(unsigned capacity);
 464
 465 WMData* WMCreateDataWithLength(unsigned length);
 466
 467 WMData* WMCreateDataWithBytes(void *bytes, unsigned length);
 468
 469 /* destructor is a function called to free the data when releasing the data
 470  * object, or NULL if no freeing of data is necesary. */
 471 WMData* WMCreateDataWithBytesNoCopy(void *bytes, unsigned length,
 472                                     WMFreeDataProc *destructor);
 473
 474 WMData* WMCreateDataWithData(WMData *aData);
 475
 476 WMData* WMRetainData(WMData *aData);
 477
 478 void WMReleaseData(WMData *aData);
 479
 480 /* Adjusting capacity */
 481
 482 void WMSetDataCapacity(WMData *aData, unsigned capacity);
 483
 484 void WMSetDataLength(WMData *aData, unsigned length);
 485
 486 void WMIncreaseDataLengthBy(WMData *aData, unsigned extraLength);
 487
 488 /* Accessing data */
 489
 490 const void* WMDataBytes(WMData *aData);
 491
 492 void WMGetDataBytes(WMData *aData, void *buffer);
 493
 494 void WMGetDataBytesWithLength(WMData *aData, void *buffer, unsigned length);
 495
 496 void WMGetDataBytesWithRange(WMData *aData, void *buffer, WMRange aRange);
 497
 498 WMData* WMGetSubdataWithRange(WMData *aData, WMRange aRange);
 499
 500 /* Testing data */
 501
 502 Bool WMIsDataEqualToData(WMData *aData, WMData *anotherData);
 503
 504 unsigned WMGetDataLength(WMData *aData);
 505
 506 /* Adding data */
 507
 508 void WMAppendDataBytes(WMData *aData, void *bytes, unsigned length);
 509
 510 void WMAppendData(WMData *aData, WMData *anotherData);
 511
 512 /* Modifying data */
 513
 514 void WMReplaceDataBytesInRange(WMData *aData, WMRange aRange, void *bytes);
 515
 516 void WMResetDataBytesInRange(WMData *aData, WMRange aRange);
 517
 518 void WMSetData(WMData *aData, WMData *anotherData);
 519
 520
 521 void WMSetDataFormat(WMData *aData, unsigned format);
 522
 523 unsigned WMGetDataFormat(WMData *aData);
 524 /* Storing data */
 525
 526
 527 /*--------------------------------------------------------------------------*/
 528
 529
 530 WMNotification *WMCreateNotification(char *name, void *object, void *clientData);
 531
 532 void WMReleaseNotification(WMNotification *notification);
 533
 534 WMNotification *WMRetainNotification(WMNotification *notification);
 535
 536 void *WMGetNotificationClientData(WMNotification *notification);
 537
 538 void *WMGetNotificationObject(WMNotification *notification);
 539
 540 char *WMGetNotificationName(WMNotification *notification);
 541
 542
 543 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 544                                void *observer, char *name, void *object);
 545
 546 void WMPostNotification(WMNotification *notification);
 547
 548 void WMRemoveNotificationObserver(void *observer);
 549
 550 void WMRemoveNotificationObserverWithName(void *observer, char *name,
 551                                           void *object);
 552
 553 void WMPostNotificationName(char *name, void *object, void *clientData);
 554
 555 WMNotificationQueue *WMGetDefaultNotificationQueue(void);
 556
 557 WMNotificationQueue *WMCreateNotificationQueue(void);
 558
 559 void WMDequeueNotificationMatching(WMNotificationQueue *queue,
 560                                    WMNotification *notification,
 561                                    unsigned mask);
 562
 563 void WMEnqueueNotification(WMNotificationQueue *queue,
 564                            WMNotification *notification,
 565                            WMPostingStyle postingStyle);
 566
 567 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 568                                    WMNotification *notification,
 569                                    WMPostingStyle postingStyle,
 570                                    unsigned coalesceMask);
 571
 572
 573 /*......................................................................*/
 574
 575 WMUserDefaults *WMGetStandardUserDefaults(void);
 576
 577 WMUserDefaults *WMGetDefaultsFromPath(char *path);
 578
 579 void WMSynchronizeUserDefaults(WMUserDefaults *database);
 580
 581 void WMSaveUserDefaults(WMUserDefaults *database);
 582
 583 void WMEnableUDPeriodicSynchronization(WMUserDefaults *database, Bool enable);
 584
 585 /* Returns a PLArray with all keys in the user defaults database.
 586  * Free the returned array with PLRelease() when no longer needed,
 587  * but do not free the elements of the array! They're just references. */
 588 proplist_t WMGetUDAllKeys(WMUserDefaults *database);
 589
 590 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 591
 592 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 593                          char *defaultName);
 594
 595 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 596
 597 char *WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 598
 599 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 600
 601 float WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 602
 603 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 604
 605 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 606                          char *defaultName);
 607
 608 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 609                           char *defaultName);
 610
 611 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 612                         char *defaultName);
 613
 614 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 615                        char *defaultName);
 616
 617 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 618
 619 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 620
 621 extern char *WMUserDefaultsDidChangeNotification;
 622
 623
 624 /*-------------------------------------------------------------------------*/
 625
 626 /* WMHost: host handling */
 627
 628 WMHost* WMGetCurrentHost();
 629
 630 WMHost* WMGetHostWithName(char* name);
 631
 632 WMHost* WMGetHostWithAddress(char* address);
 633
 634 WMHost* WMRetainHost(WMHost *hPtr);
 635
 636 void WMReleaseHost(WMHost *hPtr);
 637
 638 /*
 639  * Host cache management
 640  * If enabled, only one object representing each host will be created, and
 641  * a shared instance will be returned by all methods that return a host.
 642  * Enabled by default.
 643  */
 644 void WMSetHostCacheEnabled(Bool flag);
 645
 646 Bool WMIsHostCacheEnabled();
 647
 648 void WMFlushHostCache();
 649
 650 /*
 651  * Compare hosts: Hosts are equal if they share at least one address
 652  */
 653 Bool WMIsHostEqualToHost(WMHost* hPtr, WMHost* anotherHost);
 654
 655 /*
 656  * Host names.
 657  * WMGetHostName() will return first name (official) if a host has several.
 658  * WMGetHostNames() will return a R/O WMBag with all the names of the host.
 659  */
 660 char* WMGetHostName(WMHost* hPtr);
 661
 662 /* The returned bag is R/O. Do not modify it, and do not free it! */
 663 WMBag* WMGetHostNames(WMHost* hPtr);
 664
 665 /*
 666  * Host addresses.
 667  * Addresses are represented as "Dotted Decimal" strings, e.g. "192.42.172.1"
 668  * WMGetHostAddress() will return an arbitrary address if a host has several.
 669  * WMGetHostAddresses() will return a R/O WMBag with all addresses of the host.
 670  */
 671 char* WMGetHostAddress(WMHost* hPtr);
 672
 673 /* The returned bag is R/O. Do not modify it, and do not free it! */
 674 WMBag* WMGetHostAddresses(WMHost* hPtr);
 675
 676
 677 /*-------------------------------------------------------------------------*/
 678
 679 /* WMConnection functions */
 680
 681 WMConnection* WMCreateConnectionAsServerAtAddress(char *host, char *service,
 682                                                   char *protocol);
 683
 684 WMConnection* WMCreateConnectionToAddress(char *host, char *service,
 685                                           char *protocol);
 686
 687 WMConnection* WMCreateConnectionToAddressAndNotify(char *host, char *service,
 688                                                    char *protocol);
 689
 690 void WMCloseConnection(WMConnection *cPtr);
 691
 692 void WMDestroyConnection(WMConnection *cPtr);
 693
 694 WMConnection* WMAcceptConnection(WMConnection *listener);
 695
 696 /* Release the returned data! */
 697 WMData* WMGetConnectionAvailableData(WMConnection *cPtr);
 698
 699 int WMSendConnectionData(WMConnection *cPtr, WMData *data);
 700
 701 Bool WMEnqueueConnectionData(WMConnection *cPtr, WMData *data);
 702
 703 #define WMFlushConnection(cPtr)  WMSendConnectionData((cPtr), NULL)
 704
 705 void WMSetConnectionDelegate(WMConnection *cPtr, ConnectionDelegate *delegate);
 706
 707 /* Connection info */
 708
 709 char* WMGetConnectionAddress(WMConnection *cPtr);
 710
 711 char* WMGetConnectionService(WMConnection *cPtr);
 712
 713 char* WMGetConnectionProtocol(WMConnection *cPtr);
 714
 715 void WMSetConnectionNonBlocking(WMConnection *cPtr, Bool flag);
 716
 717 void* WMGetConnectionClientData(WMConnection *cPtr);
 718
 719 void WMSetConnectionClientData(WMConnection *cPtr, void *data);
 720
 721 unsigned int WMGetConnectionFlags(WMConnection *cPtr);
 722
 723 void WMSetConnectionFlags(WMConnection *cPtr, unsigned int flags);
 724
 725 int WMGetConnectionSocket(WMConnection *cPtr);
 726
 727 WMConnectionState WMGetConnectionState(WMConnection *cPtr);
 728
 729 WMConnectionTimeoutState WMGetConnectionTimeoutState(WMConnection *cPtr);
 730
 731 /*
 732  * Passing timeout==0 in the SetTimeout functions below, will reset that
 733  * timeout to its default value.
 734  */
 735
 736 /* The default timeout inherited by all WMConnection operations, if none set */
 737 void WMSetConnectionDefaultTimeout(unsigned int timeout);
 738
 739 /* Global timeout for all WMConnection objects, for opening a new connection */
 740 void WMSetConnectionOpenTimeout(unsigned int timeout);
 741
 742 /* Connection specific timeout for sending out data */
 743 void WMSetConnectionSendTimeout(WMConnection *cPtr, unsigned int timeout);
 744
 745
 746 /* Global variables */
 747
 748 extern int WCErrorCode;
 749
 750
 751 /*-------------------------------------------------------------------------*/
 752
 753
 754
 755 #ifdef __cplusplus
 756 }
 757 #endif /* __cplusplus */
 758
 759
 760 #endif