cruft/doc/tmpl/gras-unused.sgml

   1 <!-- ##### SECTION ./tmpl/DataDesc.sgml:Long_Description ##### -->
   2 <para>In order to allow GRAS to send data over the network (or simply to
   3 dupplicate it in SG), you have to describe the structure of data attached
   4 with each message. This mecanism is stolen from NWS message passing
   5 interface.</para>
   6
   7 <para>For each message, you have to declare a structure representing the
   8 data to send as payload with the message.</para>
   9
  10 <refsect2>
  11   <title>Sending (or receiving) simple structures</title>
  12   <para>Let's imagin you want to declare a <command>STORE_STATE</command>
  13   message, which will send some data to the memory server for inclusion in
  14   the database. Here is the structure we want to send:</para>
  15
  16 <literallayout>
  17  struct state {
  18   char id[STATE_NAME_SIZE];
  19   int rec_size;
  20   int rec_count;
  21   double seq_no;
  22   double time_out;
  23  };
  24 </literallayout>
  25
  26   <para>And here is the structure description GRAS needs to be able to send
  27   this over the network:</para>
  28
  29 <literallayout>
  30  const static DataDescriptor stateDescriptor[] =
  31   {SIMPLE_MEMBER(CHAR_TYPE, STATE_NAME_SIZE, offsetof(struct state, id)),
  32    SIMPLE_MEMBER(INT_TYPE, 1, offsetof(struct state, rec_size)),
  33    SIMPLE_MEMBER(INT_TYPE, 1, offsetof(struct state, rec_count)),
  34    SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(struct state, seq_no)),
  35    SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(struct state, time_out))};
  36 </literallayout>
  37
  38   <para>Contrary to what one could think when you first see it, it's pretty
  39   easy. A structure descriptor is a list of descriptions, describing each
  40   field of the structure. For example, for the first field, you say that
  41   the base type is <command>CHAR_TYPE</command>, that there is
  42   <command>STATE_NAME_SIZE</command> element of this type and that it's
  43   position in the structure is computed by <command>offsetof(struct state,
  44   id)</command>. This leads to two remarks:</para>
  45
  46   <itemizedlist>
  47     <listitem>
  48       <para>it's impossible to send dynamic sized strings that way. It's a
  49       known limitation, but I think we can live with it.</para>
  50     </listitem>
  51     <listitem>
  52       <para>Yes, the <command>offsetof(struct state, id)</command>
  53       construction is C ANSI and is portable.</para>
  54     </listitem>
  55   </itemizedlist>
  56 </refsect2>
  57
  58 <refsect2>
  59   <title>Sending (or receiving) complex structure</title>
  60   <para>How to send non-flat structures, do you ask? It's not harder. Let's
  61   imagin you want to send the following structure:</para>
  62
  63 <literallayout>
  64  typedef struct {
  65    unsigned long address;
  66    unsigned long port;
  67  } CliqueMember;
  68
  69  typedef struct {
  70    char name[MAX_CLIQUE_NAME_SIZE];
  71    double whenGenerated;
  72    double instance;
  73    char skill[MAX_SKILL_SIZE];
  74    char options[MAX_OPTIONS_SIZE];
  75    double period;
  76    double timeOut;
  77    CliqueMember members[MAX_MEMBERS];
  78    unsigned int count;
  79    unsigned int leader;
  80  } Clique;
  81 </literallayout>
  82
  83   <para>As you can see, this structure contains an array of another user
  84   defined structure. To be able to send <command>struct Clique</command>,
  85   you have to describe each structures that way:</para>
  86
  87 <literallayout>
  88  static const DataDescriptor cliqueMemberDescriptor[] =
  89    {SIMPLE_MEMBER(UNSIGNED_LONG_TYPE, 1, offsetof(CliqueMember, address)),
  90     SIMPLE_MEMBER(UNSIGNED_LONG_TYPE, 1, offsetof(CliqueMember, port))};
  91
  92  static const DataDescriptor cliqueDescriptor[] =
  93    {SIMPLE_MEMBER(CHAR_TYPE, MAX_CLIQUE_NAME_SIZE, offsetof(Clique, name)),
  94     SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(Clique, whenGenerated)),
  95     SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(Clique, instance)),
  96     SIMPLE_MEMBER(CHAR_TYPE, MAX_SKILL_SIZE, offsetof(Clique, skill)),
  97     SIMPLE_MEMBER(CHAR_TYPE, MAX_OPTIONS_SIZE, offsetof(Clique, options)),
  98     SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(Clique, period)),
  99     SIMPLE_MEMBER(DOUBLE_TYPE, 1, offsetof(Clique, timeOut)),
 100     {STRUCT_TYPE, MAX_MEMBERS, offsetof(Clique, members),
 101      (DataDescriptor *)&amp;cliqueMemberDescriptor, cliqueMemberDescriptorLength,
 102      PAD_BYTES(CliqueMember, port, unsigned long, 1)},
 103     SIMPLE_MEMBER(UNSIGNED_INT_TYPE, 1, offsetof(Clique, count)),
 104     SIMPLE_MEMBER(UNSIGNED_INT_TYPE, 1, offsetof(Clique, leader))};
 105 </literallayout>
 106
 107   <para>So, even if less natural, it is possible to send structures
 108   containing structures with these tools.</para>
 109
 110   <para>You can see that it's not only impossible to send dynamic-sized
 111   strings, it impossible to send dynamic-sized arrays. Here,
 112   <command>MAX_MEMBERS</command> is the maximum of members a clique can
 113   contain. In NWS, this value is defined to 100.  <warning><para>I'm not
 114   sure, but I think that all the 100 values are sent each time, even if
 115   there is only 3 non-null members. Yes, that's
 116   bad.</para></warning></para>
 117
 118   <warning><para>The DataDescriptor_t MUST be const. Malloc'ing them and
 119   then casting them on argument passing IS NOT OK. This is because we get
 120   the number of elements in the array with the sizeof(dd)/sizeof(dd[0]).
 121   </para></warning>
 122 </refsect2>
 123
 124
 125 <!-- ##### SECTION ./tmpl/DataDesc.sgml:See_Also ##### -->
 126 <para>
 127
 128 </para>
 129
 130
 131 <!-- ##### SECTION ./tmpl/DataDesc.sgml:Short_Description ##### -->
 132 Describing the data
 133
 134
 135 <!-- ##### SECTION ./tmpl/DataDesc.sgml:Title ##### -->
 136 DataDescriptor API
 137
 138
 139 <!-- ##### SECTION ./tmpl/Dynamic_arrays.sgml:Long_Description ##### -->
 140 <para>
 141
 142 </para>
 143
 144
 145 <!-- ##### SECTION ./tmpl/Dynamic_arrays.sgml:See_Also ##### -->
 146 <para>
 147
 148 </para>
 149
 150
 151 <!-- ##### SECTION ./tmpl/Dynamic_arrays.sgml:Short_Description ##### -->
 152
 153
 154
 155 <!-- ##### SECTION ./tmpl/Dynamic_arrays.sgml:Title ##### -->
 156 Dynamic arrays
 157
 158
 159 <!-- ##### SECTION ./tmpl/ErrLog.sgml:Long_Description ##### -->
 160 <para>
 161
 162 </para>
 163
 164
 165 <!-- ##### SECTION ./tmpl/ErrLog.sgml:See_Also ##### -->
 166 <para>
 167
 168 </para>
 169
 170
 171 <!-- ##### SECTION ./tmpl/ErrLog.sgml:Short_Description ##### -->
 172
 173
 174
 175 <!-- ##### SECTION ./tmpl/ErrLog.sgml:Title ##### -->
 176 ErrLog
 177
 178
 179 <!-- ##### SECTION ./tmpl/Socks.sgml:Long_Description ##### -->
 180 <para>
 181
 182 </para>
 183
 184
 185 <!-- ##### SECTION ./tmpl/Socks.sgml:See_Also ##### -->
 186 <para>
 187
 188 </para>
 189
 190
 191 <!-- ##### SECTION ./tmpl/Socks.sgml:Short_Description ##### -->
 192 Handling sockets
 193
 194
 195 <!-- ##### SECTION ./tmpl/Socks.sgml:Title ##### -->
 196 Sockets API
 197
 198
 199 <!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Long_Description ##### -->
 200 <para>
 201
 202 </para>
 203
 204
 205 <!-- ##### SECTION ./tmpl/comm_callbacks.sgml:See_Also ##### -->
 206 <para>
 207
 208 </para>
 209
 210
 211 <!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Short_Description ##### -->
 212
 213
 214
 215 <!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Title ##### -->
 216 comm_callbacks
 217
 218
 219 <!-- ##### SECTION ./tmpl/comm_cb.sgml:Long_Description ##### -->
 220 <para>
 221
 222 </para>
 223
 224
 225 <!-- ##### SECTION ./tmpl/comm_cb.sgml:See_Also ##### -->
 226 <para>
 227
 228 </para>
 229
 230
 231 <!-- ##### SECTION ./tmpl/comm_cb.sgml:Short_Description ##### -->
 232
 233
 234
 235 <!-- ##### SECTION ./tmpl/comm_cb.sgml:Title ##### -->
 236 comm_cb
 237
 238
 239 <!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Long_Description ##### -->
 240 <para>
 241
 242 </para>
 243
 244
 245 <!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:See_Also ##### -->
 246 <para>
 247
 248 </para>
 249
 250
 251 <!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Short_Description ##### -->
 252 Advanced ways to describe data (for experts)
 253
 254
 255 <!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Title ##### -->
 256 Advanced Data description
 257
 258
 259 <!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:Long_Description ##### -->
 260 <para>
 261
 262 </para>
 263
 264
 265 <!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:See_Also ##### -->
 266 <para>
 267
 268 </para>
 269
 270
 271 <!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:Short_Description ##### -->
 272
 273
 274
 275 <!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:Title ##### -->
 276 Data description callbacks persistant state
 277
 278
 279 <!-- ##### SECTION ./tmpl/config.sgml:Long_Description ##### -->
 280 <para>
 281
 282 </para>
 283
 284
 285 <!-- ##### SECTION ./tmpl/config.sgml:See_Also ##### -->
 286 <para>
 287
 288 </para>
 289
 290
 291 <!-- ##### SECTION ./tmpl/config.sgml:Short_Description ##### -->
 292
 293
 294
 295 <!-- ##### SECTION ./tmpl/config.sgml:Title ##### -->
 296 config
 297
 298
 299 <!-- ##### SECTION ./tmpl/dd_cbps.sgml:Long_Description ##### -->
 300 <para>
 301
 302 </para>
 303
 304
 305 <!-- ##### SECTION ./tmpl/dd_cbps.sgml:See_Also ##### -->
 306 <para>
 307
 308 </para>
 309
 310
 311 <!-- ##### SECTION ./tmpl/dd_cbps.sgml:Short_Description ##### -->
 312
 313
 314
 315 <!-- ##### SECTION ./tmpl/dd_cbps.sgml:Title ##### -->
 316 Data description callbacks persistant state
 317
 318
 319 <!-- ##### SECTION ./tmpl/dd_internal.sgml:Long_Description ##### -->
 320 <para>
 321
 322 </para>
 323
 324
 325 <!-- ##### SECTION ./tmpl/dd_internal.sgml:See_Also ##### -->
 326 <para>
 327
 328 </para>
 329
 330
 331 <!-- ##### SECTION ./tmpl/dd_internal.sgml:Short_Description ##### -->
 332
 333
 334
 335 <!-- ##### SECTION ./tmpl/dd_internal.sgml:Title ##### -->
 336 Implementation of data description
 337
 338
 339 <!-- ##### SECTION ./tmpl/dico.sgml:Long_Description ##### -->
 340 <para>
 341
 342 </para>
 343
 344
 345 <!-- ##### SECTION ./tmpl/dico.sgml:See_Also ##### -->
 346 <para>
 347
 348 </para>
 349
 350
 351 <!-- ##### SECTION ./tmpl/dico.sgml:Short_Description ##### -->
 352
 353
 354
 355 <!-- ##### SECTION ./tmpl/dico.sgml:Title ##### -->
 356 dico
 357
 358
 359 <!-- ##### SECTION ./tmpl/dynar.sgml:Long_Description ##### -->
 360 <para>
 361 This module provide the quite usual dynamic array facility.
 362 </para>
 363
 364
 365 <!-- ##### SECTION ./tmpl/dynar.sgml:See_Also ##### -->
 366 <para>
 367
 368 </para>
 369
 370
 371 <!-- ##### SECTION ./tmpl/dynar.sgml:Short_Description ##### -->
 372 Dynamic array
 373
 374
 375 <!-- ##### SECTION ./tmpl/dynar.sgml:Title ##### -->
 376 dynar
 377
 378
 379 <!-- ##### SECTION ./tmpl/gras-overview.sgml:Long_Description ##### -->
 380     <para>This document introduce the GRAS library (<emphasis>Grid Reality
 381     And Simulation</emphasis>, or according to my english dictionary,
 382     <emphasis>Generally Recognized As Safe</emphasis> ;).</para>
 383
 384     <refsect2>
 385       <title>Overview</title>
 386       <para>The purpose of the GRAS is to allow the developpement of
 387       distributed programs which will work with as few as possible
 388       modification both on the SimGrid simulator (SG), and in the Real Life
 389       (RL).</para>
 390
 391       <para>Here are the problems when you want to do so:
 392         <itemizedlist>
 393           <listitem>
 394             <para>Communication in SG is done by passing tasks, while in
 395             RL, you have to deal with sockets (or any wrapper to it).</para>
 396           </listitem>
 397           <listitem><para>In RL, each process should provide a main()
 398             function, and it's obviously not the case in SG.</para>
 399           </listitem>
 400         </itemizedlist>
 401       </para>
 402     </refsect2>
 403     <refsect2>
 404       <title>Application class target</title>
 405       <para>If you want to run your code both in RL and in SG, you won't be
 406       able to use the full set of features offered by any of those two
 407       worlds. GRAS tries to provide a suffisent set of features to develop
 408       your application, and implement them in both worlds.</para>
 409
 410       <para>GRAS uses the paradigm of <emphasis>event-driven
 411       programming</emphasis>, which is an extension to the message-passing
 412       one. Any process of a typical event-driven application declares
 413       callback to incoming events, which can be messages from other
 414       processes, timers or others.</para>
 415
 416       <para>All messages have an header, specifying its type, and attached
 417       data, represented as one or several C structures. In order to send
 418       the data over the network in RL, a type-description mecanism is
 419       provided, and the RL version of GRAS implements CDR
 420       functionnalities. That is to say that the data are sent in the native
 421       format of the sender host, and converted on the destination host only
 422       if needed.</para>
 423
 424       <para>In order to not reimplement the wheel, GRAS use existing code,
 425       and adapt them to make them work together. The SG version naturally
 426       use the SimGrid toolkit, while the RL version is based over the
 427       communication library used in NWS (note that this library was somehow
 428       modified, since the previous version use XDR, ie both the sender and
 429       the receiver convert the data from/to a so called network
 430       format). That's why some basic knowledge about how NWS work is
 431       supposed in this document. But don't worry, you only have to know the
 432       basics about NWS, the internals needed to understand the document
 433       will be presented when needed.</para>
 434     </refsect2>
 435
 436
 437 <!-- ##### SECTION ./tmpl/gras-overview.sgml:See_Also ##### -->
 438 <para>
 439
 440 </para>
 441
 442
 443 <!-- ##### SECTION ./tmpl/gras-overview.sgml:Short_Description ##### -->
 444 Overview of the GRAS library
 445
 446
 447 <!-- ##### SECTION ./tmpl/gras-overview.sgml:Title ##### -->
 448 Overview
 449
 450
 451 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 452 <para>
 453
 454 </para>
 455
 456
 457 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 458 <para>
 459
 460 </para>
 461
 462
 463 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 464
 465
 466
 467 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 468 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 469
 470
 471 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 472 <para>
 473
 474 </para>
 475
 476
 477 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 478 <para>
 479
 480 </para>
 481
 482
 483 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 484
 485
 486
 487 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 488 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 489
 490
 491 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 492 <para>
 493
 494 </para>
 495
 496
 497 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 498 <para>
 499
 500 </para>
 501
 502
 503 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 504
 505
 506
 507 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 508 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 509
 510
 511 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 512 <para>
 513
 514 </para>
 515
 516
 517 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 518 <para>
 519
 520 </para>
 521
 522
 523 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 524
 525
 526
 527 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 528 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 529
 530
 531 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 532 <para>
 533
 534 </para>
 535
 536
 537 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 538 <para>
 539
 540 </para>
 541
 542
 543 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 544
 545
 546
 547 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 548 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 549
 550
 551 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 552 <para>
 553
 554 </para>
 555
 556
 557 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 558 <para>
 559
 560 </para>
 561
 562
 563 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 564
 565
 566
 567 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 568 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 569
 570
 571 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 572 <para>
 573
 574 </para>
 575
 576
 577 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 578 <para>
 579
 580 </para>
 581
 582
 583 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 584
 585
 586
 587 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 588 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml
 589
 590
 591 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 592 <para>
 593
 594 </para>
 595
 596
 597 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 598 <para>
 599
 600 </para>
 601
 602
 603 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 604
 605
 606
 607 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 608 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml
 609
 610
 611 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 612 <para>
 613
 614 </para>
 615
 616
 617 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 618 <para>
 619
 620 </para>
 621
 622
 623 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 624
 625
 626
 627 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 628 ./gras-sections.txt.sgml.sgml.sgml.sgml.sgml
 629
 630
 631 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
 632 <para>
 633
 634 </para>
 635
 636
 637 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
 638 <para>
 639
 640 </para>
 641
 642
 643 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
 644
 645
 646
 647 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml.sgml:Title ##### -->
 648 ./gras-sections.txt.sgml.sgml.sgml.sgml
 649
 650
 651 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml:Long_Description ##### -->
 652 <para>
 653
 654 </para>
 655
 656
 657 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml:See_Also ##### -->
 658 <para>
 659
 660 </para>
 661
 662
 663 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml:Short_Description ##### -->
 664
 665
 666
 667 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml.sgml:Title ##### -->
 668 ./gras-sections.txt.sgml.sgml.sgml
 669
 670
 671 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml:Long_Description ##### -->
 672 <para>
 673
 674 </para>
 675
 676
 677 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml:See_Also ##### -->
 678 <para>
 679
 680 </para>
 681
 682
 683 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml:Short_Description ##### -->
 684
 685
 686
 687 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml.sgml:Title ##### -->
 688 ./gras-sections.txt.sgml.sgml
 689
 690
 691 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml:Long_Description ##### -->
 692 <para>
 693
 694 </para>
 695
 696
 697 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml:See_Also ##### -->
 698 <para>
 699
 700 </para>
 701
 702
 703 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml:Short_Description ##### -->
 704
 705
 706
 707 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml.sgml:Title ##### -->
 708 ./gras-sections.txt.sgml
 709
 710
 711 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml:Long_Description ##### -->
 712 <para>
 713
 714 </para>
 715
 716
 717 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml:See_Also ##### -->
 718 <para>
 719
 720 </para>
 721
 722
 723 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml:Short_Description ##### -->
 724
 725
 726
 727 <!-- ##### SECTION ./tmpl/gras-sections.txt.sgml:Title ##### -->
 728 ./gras-sections.txt
 729
 730
 731 <!-- ##### SECTION ./tmpl/gras.sgml:Long_Description ##### -->
 732 <para>
 733
 734 </para>
 735
 736
 737 <!-- ##### SECTION ./tmpl/gras.sgml:See_Also ##### -->
 738 <para>
 739
 740 </para>
 741
 742
 743 <!-- ##### SECTION ./tmpl/gras.sgml:Short_Description ##### -->
 744
 745
 746
 747 <!-- ##### SECTION ./tmpl/gras.sgml:Title ##### -->
 748 gras
 749
 750
 751 <!-- ##### SECTION ./tmpl/gras_private.sgml:Long_Description ##### -->
 752 <para>
 753
 754 </para>
 755
 756
 757 <!-- ##### SECTION ./tmpl/gras_private.sgml:See_Also ##### -->
 758 <para>
 759
 760 </para>
 761
 762
 763 <!-- ##### SECTION ./tmpl/gras_private.sgml:Short_Description ##### -->
 764
 765
 766
 767 <!-- ##### SECTION ./tmpl/gras_private.sgml:Title ##### -->
 768 gras_private
 769
 770
 771 <!-- ##### SECTION ./tmpl/gras_rl.sgml:Long_Description ##### -->
 772 <para>
 773
 774 </para>
 775
 776
 777 <!-- ##### SECTION ./tmpl/gras_rl.sgml:See_Also ##### -->
 778 <para>
 779
 780 </para>
 781
 782
 783 <!-- ##### SECTION ./tmpl/gras_rl.sgml:Short_Description ##### -->
 784 Implementation of GRAS suited for real life.
 785
 786
 787 <!-- ##### SECTION ./tmpl/gras_rl.sgml:Title ##### -->
 788 RL
 789
 790
 791 <!-- ##### SECTION ./tmpl/gras_sg.sgml:Long_Description ##### -->
 792 <para>
 793   SimGrid was designed to ease the comparison of algorithms and
 794   heuristics. That way, a lot of complicated notion from the system layer
 795   were volontary left off. For example, migrating a process from an host to
 796   another is as easy as: MSG_process_change_host(process, new_host).
 797 </para>
 798
 799 <para>
 800   No need to tell that performing this operation on real platform is really
 801   harder. This simplification is a very good thing when you want to rapidly
 802   prototype code, but makes things somehow more complicated in GRAS since
 803   we want to have a realistic API, since it have to be implemented in
 804   reality also.
 805 </para>
 806
 807 <para>
 808   The best example of complexity in GRAS_SG induced by simplicity in
 809   SimGrid is the sockets handling. There is no "socket" in SG, but only
 810   m_channel_t. In contrary to sockets from RL, no special treatment is
 811   needed for a process before writing or reading on/from a channel. So, a
 812   given channel can be pooled by more than one process. Likewise, you can
 813   send data to a channel that nobody is actually listening to.
 814 </para>
 815
 816 <para>
 817   The SG implementation of GRAS repport as an error the fact that nobody is
 818   listening to the socket when trying to open a socket, or send stuff using
 819   a previously openned socket. That way, the SG version can be used to
 820   debug all syncronization issues. For that, we store mainly the PID of
 821   both the sender and the receiver in the socket structure, and then
 822   resolve PID->process at the lastest moment. This search is a bit
 823   expensive, but as long as there is no real garbage collection in SG, with
 824   the information "dead process" within the structure, it's the only
 825   solution to make sure that we won't dereference pointers to an old freed
 826   structure when the process on the other side of the structure did finish
 827   since the creation of the socket.
 828 </para>
 829
 830 <para>
 831   As said in the overview, the processes can declare to hear on several
 832   sockets, but all incoming messages are handled by the same loop. So, we
 833   can use only one channel per process, and use a table on each host to
 834   determine to which process a message should be delivered depending on the
 835   socket number provided by the sender.
 836 </para>
 837
 838
 839 <!-- ##### SECTION ./tmpl/gras_sg.sgml:See_Also ##### -->
 840 <para>
 841 RL, the implementation suited for real life.
 842 </para>
 843
 844 <!--
 845 Local variables:
 846 sgml-parent-document:\.\./gras-docs\.sgml
 847 sgml-omittag:t
 848 sgml-shorttag:t
 849 sgml-namecase-general:t
 850 sgml-general-insert-case:lower
 851 sgml-minimize-attributes:nil
 852 sgml-always-quote-attributes:t
 853 sgml-indent-step:2
 854 sgml-indent-data:nil
 855 sgml-exposed-tags:nil
 856 sgml-local-catalogs:nil
 857 sgml-local-ecat-files:nil
 858 End:
 859 -->
 860
 861
 862 <!-- ##### SECTION ./tmpl/gras_sg.sgml:Short_Description ##### -->
 863 Implementation of GRAS on top of the simulator.
 864
 865
 866 <!-- ##### SECTION ./tmpl/gras_sg.sgml:Title ##### -->
 867 SG
 868
 869
 870 <!-- ##### SECTION ./tmpl/nws_comm.sgml:Long_Description ##### -->
 871 <para>
 872
 873 </para>
 874
 875
 876 <!-- ##### SECTION ./tmpl/nws_comm.sgml:See_Also ##### -->
 877 <para>
 878
 879 </para>
 880
 881
 882 <!-- ##### SECTION ./tmpl/nws_comm.sgml:Short_Description ##### -->
 883
 884
 885
 886 <!-- ##### SECTION ./tmpl/nws_comm.sgml:Title ##### -->
 887 nws_comm
 888
 889
 890 <!-- ##### SECTION ./tmpl/tbx_cfg.sgml:Long_Description ##### -->
 891 <para>
 892
 893 </para>
 894
 895
 896 <!-- ##### SECTION ./tmpl/tbx_cfg.sgml:See_Also ##### -->
 897 <para>
 898
 899 </para>
 900
 901
 902 <!-- ##### SECTION ./tmpl/tbx_cfg.sgml:Short_Description ##### -->
 903 Configuration facilities.
 904
 905
 906 <!-- ##### SECTION ./tmpl/tbx_cfg.sgml:Title ##### -->
 907 Config
 908
 909
 910 <!-- ##### SECTION ./tmpl/tbx_dico.sgml:Long_Description ##### -->
 911 <para>
 912
 913 </para>
 914
 915
 916 <!-- ##### SECTION ./tmpl/tbx_dico.sgml:See_Also ##### -->
 917 <para>
 918
 919 </para>
 920
 921
 922 <!-- ##### SECTION ./tmpl/tbx_dico.sgml:Short_Description ##### -->
 923 Data container associating data to a string key.
 924
 925
 926 <!-- ##### SECTION ./tmpl/tbx_dico.sgml:Title ##### -->
 927 Dictionnary
 928
 929
 930 <!-- ##### SECTION ./tmpl/tbx_dynar.sgml:Long_Description ##### -->
 931 <para>
 932 This module provide the quite usual dynamic array facility.
 933 </para>
 934
 935
 936 <!-- ##### SECTION ./tmpl/tbx_dynar.sgml:See_Also ##### -->
 937 <para>
 938
 939 </para>
 940
 941
 942 <!-- ##### SECTION ./tmpl/tbx_dynar.sgml:Short_Description ##### -->
 943 Use arrays, forget about malloc
 944
 945
 946 <!-- ##### SECTION ./tmpl/tbx_dynar.sgml:Title ##### -->
 947 Dynamic array
 948
 949
 950 <!-- ##### SECTION ./tmpl/tbx_err.sgml:Long_Description ##### -->
 951 <para>
 952
 953 </para>
 954
 955
 956 <!-- ##### SECTION ./tmpl/tbx_err.sgml:See_Also ##### -->
 957 <para>
 958
 959 </para>
 960
 961
 962 <!-- ##### SECTION ./tmpl/tbx_err.sgml:Short_Description ##### -->
 963 Error reporting
 964
 965
 966 <!-- ##### SECTION ./tmpl/tbx_err.sgml:Title ##### -->
 967 Errors handling
 968
 969
 970 <!-- ##### SECTION ./tmpl/tbx_log.sgml:Long_Description ##### -->
 971 <para>
 972   This is an adaptation of the log4c project, which is dead upstream, and which
 973   I was given the permission to fork under the LGPL licence by the authors. log4c
 974   itself was loosely based on the Apache project's Log4J, Log4CC,
 975   etc. project. Because C is not object oriented, a lot had to change.
 976 </para>
 977
 978 <refsect2>
 979   <title>Overview</title>
 980
 981   <para>
 982     There is 3 main concepts: category, priority and appender. These three
 983     concepts work together to enable developers to log messages according to
 984     message type and priority, and to control at runtime how these messages are
 985     formatted and where they are reported.
 986   </para>
 987 </refsect2>
 988
 989 <refsect2>
 990  <title>Category hierarchy</title>
 991
 992   <para>
 993     The first and foremost advantage of any logging API over plain printf()
 994     resides in its ability to disable certain log statements while allowing
 995     others to print unhindered. This capability assumes that the logging space,
 996     that is, the space of all possible logging statements, is categorized
 997     according to some developer-chosen criteria.
 998   </para>
 999
1000   <para>
1001     This observation led to choosing category as the central concept of the
1002     system. Every category is declared by providing a name and an optional
1003     parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT
1004     is the category's parent.
1005   </para>
1006
1007   <para>
1008     A category is created by a macro call at the top level of a file.  A
1009     category can be created with any one of the following macros:
1010   </para>
1011
1012   <itemizedlist>
1013     <listitem>
1014      <para>@GRAS_LOG_NEW_CATEGORY(MyCat);</para>
1015      <para>create a new root</para>
1016     </listitem>
1017
1018     <listitem>
1019       <para>@GRAS_LOG_NEW_SUBCATEGORY(MyCat, ParentCat);</para>
1020       <para>Create a new category being child of the category ParentCat</para>
1021     </listitem>
1022
1023     <listitem>
1024       <para>@GRAS_LOG_NEW_DEFAULT_CATEGORY(MyCat);</para>
1025       <para>Like GRAS_LOG_NEW_CATEGORY, but the new category is the default one
1026       in this file</para>
1027     </listitem>
1028
1029     <listitem>
1030       <para>@GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat);</para>
1031       <para>Like GRAS_LOG_NEW_SUBCATEGORY, but the new category is the default one
1032       in this file</para>
1033     </listitem>
1034   </itemizedlist>
1035
1036   <para>
1037     The parent cat can be defined in the same file or in another file, but each
1038     category may have only one definition.
1039   </para>
1040
1041   <para>
1042     Typically, there will be a Category for each module and sub-module, so you
1043     can independently control logging for each module.
1044   </para>
1045 </refsect2>
1046
1047 <refsect2>
1048   <title>Priority</title>
1049
1050   <para>
1051     A category may be assigned a threshold priorty. The set of priorites are
1052     defined by the @gras_log_priority_t enum. Their values are DEBUG, VERBOSE,
1053     INFO, WARNING, ERROR and CRITICAL.
1054   </para>
1055
1056   <para>
1057     If a given category is not assigned a threshold priority, then it inherits
1058     one from its closest ancestor with an assigned threshold.
1059   </para>
1060
1061   <para>
1062     To ensure that all categories can eventually inherit a threshold, the root
1063     category always has an assigned threshold priority.
1064   </para>
1065
1066   <para>
1067     Logging requests are made by invoking a logging macro on a category.  All
1068     of the macros have a printf-style format string followed by arguments.
1069     Because most C compilers do not support vararg macros, there is a version
1070     of the macro for any number of arguments from 0 to 6. The macro name ends
1071     with the total number of arguments.
1072   </para>
1073
1074   <para>
1075     Here is an example of the most basic type of macro:
1076   </para>
1077
1078   <programlisting>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5, "oops");</programlisting>
1079
1080   <para>This is a logging request with priority WARN.</para>
1081
1082   <para>
1083     A logging request is said to be enabled if its priority is higher than or
1084     equal to the threshold priority of its category. Otherwise, the request is
1085     said to be disabled. A category without an assigned priority will inherit
1086     one from the hierarchy.
1087   </para>
1088
1089   <para>
1090     It is possible to use any non-negative integer as a priority. If, as in the
1091     example, one of the standard priorites is used, then there is a convenience
1092     macro that is typically used instead. For example, the above example is
1093     equivalent to the shorter:
1094   </para>
1095
1096   <programlisting>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</programlisting>
1097 </refsect2>
1098
1099 <refsect2>
1100   <title>Default category</title>
1101
1102   <para>
1103     If @GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
1104     @GRAS_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the category, then
1105     the even shorter form can be used:
1106   </para>
1107
1108   <programlisting>WARN3("Values are: %d and '%s'", 5, "oops");</programlisting>
1109
1110   <para>
1111    Only one default category can be created per file, though multiple
1112    non-defaults can be created and used.
1113   </para>
1114 </refsect2>
1115
1116 <refsect2>
1117   <title>Example</title>
1118
1119   <para>Here is a more complete example:</para>
1120
1121   <programlisting>
1122      #include "gras.h"
1123
1124      /* create a category and a default subcategory */
1125      GRAS_LOG_NEW_CATEGORY(VSS);
1126      GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
1127
1128      main() {
1129             /* Now set the parent's priority.
1130                (the string would typcially be a runtime option) */
1131             gras_log_control_set("SA.thresh=3");
1132
1133             /* This request is enabled, because WARNING &gt;= INFO. */
1134             CWARN2(VSS, "Low fuel level.");
1135
1136             /* This request is disabled, because DEBUG &lt; INFO. */
1137             CDEBUG2(VSS, "Starting search for nearest gas station.");
1138
1139             /* The default category SA inherits its priority from VSS. Thus,
1140                the following request is enabled because INFO &gt;= INFO.  */
1141             INFO1("Located nearest gas station.");
1142
1143             /* This request is disabled, because DEBUG &lt; INFO. */
1144             DEBUG1("Exiting gas station search");
1145       }</programlisting>
1146 </refsect2>
1147
1148 <refsect2>
1149   <title>Configuration</title>
1150
1151   <para>
1152     Configuration is typically done during program initialization by invoking
1153     the gras_log_control_set() method. The control string passed to it
1154     typically comes from the command line. Look at the doucmentation for that
1155     function for the format of the control string.
1156   </para>
1157 </refsect2>
1158
1159 <refsect2>
1160   <title>Performance</title>
1161
1162   <para>
1163     Clever design insures efficiency. Except for the first invocation, a
1164     disabled logging request requires an a single comparison of a static
1165     variable to a constant.
1166   </para>
1167
1168   <para>
1169     There is also compile time constant, @GRAS_LOG_STATIC_THRESHOLD, which
1170     causes all logging requests with a lower priority to be optimized to 0 cost
1171     by the compiler. By setting it to gras_log_priority_infinite, all logging
1172     requests are statically disabled and cost nothing. Released executables
1173     might typically be compiled with
1174     "-DGRAS_LOG_STATIC_THRESHOLD=gras_log_priority_infinite".
1175   </para>
1176 </refsect2>
1177
1178 <refsect2>
1179   <title>Appenders</title>
1180
1181   <para>
1182     Each category has an optional appender. An appender is a pointer to a
1183     structure whcih starts with a pointer to a doAppend() function. DoAppend()
1184     prints a message to a log.
1185   </para>
1186
1187   <para>
1188     WHen a category is passed a message by one of the logging macros, the
1189     category performs the following actions:
1190   </para>
1191
1192   <itemizedlist>
1193     <listitem>
1194        <para>
1195          if the category has an appender, the message is passed to the
1196          appender's doAppend() function,
1197        </para>
1198     </listitem>
1199
1200     <listitem>
1201        <para>
1202          if 'willLogToParent' is true for the category, the message is passed
1203          to the category's parent.
1204       </para>
1205
1206       <para>
1207          By default, all categories except root have no appender and
1208          'willLogToParent' is true. This situation causes all messages to be
1209          logged by the root category's appender.
1210       </para>
1211
1212       <para>
1213          Typically, you would only change the root category's appender when you
1214          wanted, say, a different output format. Copying defaultLogAppender.c
1215          would be a good start.
1216       </para>
1217
1218       <para>
1219          The default appender function currently prints to stderr, but more
1220          would be needed, like the one able to send the logs to a remote
1221          dedicated server.
1222       </para>
1223     </listitem>
1224   </itemizedlist>
1225 </refsect2>
1226
1227 <refsect2>
1228   <title>Misc and Caveats</title>
1229
1230   <para>
1231     Do not use any of the macros that start with '_'.
1232   </para>
1233
1234   <para>
1235     The current set of macros force each file to use categories declared in
1236     that file. This is intentional. Make the category a child of the file's
1237     module category.
1238   </para>
1239
1240   <para>
1241     Log4J has a 'rolling file appender' which you can select with a run-time
1242     option and specify the max file size. This would be a nice default for
1243     non-kernel applications.
1244   </para>
1245
1246   <para>
1247     Careful, category names are global variables.
1248   </para>
1249 </refsect2>
1250
1251
1252 <!-- ##### SECTION ./tmpl/tbx_log.sgml:See_Also ##### -->
1253 <para>
1254
1255 </para>
1256
1257
1258 <!-- ##### SECTION ./tmpl/tbx_log.sgml:Short_Description ##### -->
1259 An easy-to-use, fast and flexible message logging architecture.
1260
1261
1262 <!-- ##### SECTION ./tmpl/tbx_log.sgml:Title ##### -->
1263 Logging facilities
1264
1265
1266 <!-- ##### SECTION ./tmpl/tbx_set.sgml:Long_Description ##### -->
1267 <para>
1268
1269 </para>
1270
1271
1272 <!-- ##### SECTION ./tmpl/tbx_set.sgml:See_Also ##### -->
1273 <para>
1274
1275 </para>
1276
1277
1278 <!-- ##### SECTION ./tmpl/tbx_set.sgml:Short_Description ##### -->
1279 Data storage for very quick retrieve
1280
1281
1282 <!-- ##### SECTION ./tmpl/tbx_set.sgml:Title ##### -->
1283 Data set
1284
1285
1286 <!-- ##### SECTION ./tmpl/trp_socks.sgml:Long_Description ##### -->
1287 <para>
1288
1289 </para>
1290
1291
1292 <!-- ##### SECTION ./tmpl/trp_socks.sgml:See_Also ##### -->
1293 <para>
1294
1295 </para>
1296
1297
1298 <!-- ##### SECTION ./tmpl/trp_socks.sgml:Short_Description ##### -->
1299
1300
1301
1302 <!-- ##### SECTION ./tmpl/trp_socks.sgml:Title ##### -->
1303 Sockets
1304
1305
1306 <!-- ##### SECTION ./tmpl/xbt_cfg.sgml:Long_Description ##### -->
1307 <para>
1308
1309 </para>
1310
1311
1312 <!-- ##### SECTION ./tmpl/xbt_cfg.sgml:See_Also ##### -->
1313 <para>
1314
1315 </para>
1316
1317
1318 <!-- ##### SECTION ./tmpl/xbt_cfg.sgml:Short_Description ##### -->
1319
1320
1321
1322 <!-- ##### SECTION ./tmpl/xbt_cfg.sgml:Title ##### -->
1323 xbt_cfg
1324
1325
1326 <!-- ##### SECTION ./tmpl/xbt_dico.sgml:Long_Description ##### -->
1327 <para>
1328
1329 </para>
1330
1331
1332 <!-- ##### SECTION ./tmpl/xbt_dico.sgml:See_Also ##### -->
1333 <para>
1334
1335 </para>
1336
1337
1338 <!-- ##### SECTION ./tmpl/xbt_dico.sgml:Short_Description ##### -->
1339
1340
1341
1342 <!-- ##### SECTION ./tmpl/xbt_dico.sgml:Title ##### -->
1343 xbt_dico
1344
1345
1346 <!-- ##### SECTION ./tmpl/xbt_err.sgml:Long_Description ##### -->
1347 <para>
1348
1349 </para>
1350
1351
1352 <!-- ##### SECTION ./tmpl/xbt_err.sgml:See_Also ##### -->
1353 <para>
1354
1355 </para>
1356
1357
1358 <!-- ##### SECTION ./tmpl/xbt_err.sgml:Short_Description ##### -->
1359
1360
1361
1362 <!-- ##### SECTION ./tmpl/xbt_err.sgml:Title ##### -->
1363 Errors
1364
1365
1366 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
1367 <para>
1368
1369 </para>
1370
1371
1372 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
1373 <para>
1374
1375 </para>
1376
1377
1378 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
1379
1380
1381
1382 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
1383 xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml
1384
1385
1386 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
1387 <para>
1388
1389 </para>
1390
1391
1392 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
1393 <para>
1394
1395 </para>
1396
1397
1398 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
1399
1400
1401
1402 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
1403 xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml
1404
1405
1406 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
1407 <para>
1408
1409 </para>
1410
1411
1412 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
1413 <para>
1414
1415 </para>
1416
1417
1418 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
1419
1420
1421
1422 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
1423 xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml
1424
1425
1426 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
1427 <para>
1428
1429 </para>
1430
1431
1432 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
1433 <para>
1434
1435 </para>
1436
1437
1438 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
1439
1440
1441
1442 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml.sgml:Title ##### -->
1443 xbt_swag.sgml.sgml.sgml.sgml.sgml
1444
1445
1446 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml:Long_Description ##### -->
1447 <para>
1448
1449 </para>
1450
1451
1452 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml:See_Also ##### -->
1453 <para>
1454
1455 </para>
1456
1457
1458 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml:Short_Description ##### -->
1459
1460
1461
1462 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml.sgml:Title ##### -->
1463 xbt_swag.sgml.sgml.sgml.sgml
1464
1465
1466 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml:Long_Description ##### -->
1467 <para>
1468
1469 </para>
1470
1471
1472 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml:See_Also ##### -->
1473 <para>
1474
1475 </para>
1476
1477
1478 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml:Short_Description ##### -->
1479
1480
1481
1482 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml.sgml:Title ##### -->
1483 xbt_swag.sgml.sgml.sgml
1484
1485
1486 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml:Long_Description ##### -->
1487 <para>
1488
1489 </para>
1490
1491
1492 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml:See_Also ##### -->
1493 <para>
1494
1495 </para>
1496
1497
1498 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml:Short_Description ##### -->
1499
1500
1501
1502 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml.sgml:Title ##### -->
1503 xbt_swag.sgml.sgml
1504
1505
1506 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml:Long_Description ##### -->
1507 <para>
1508
1509 </para>
1510
1511
1512 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml:See_Also ##### -->
1513 <para>
1514
1515 </para>
1516
1517
1518 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml:Short_Description ##### -->
1519
1520
1521
1522 <!-- ##### SECTION ./tmpl/xbt_swag.sgml.sgml:Title ##### -->
1523 xbt_swag.sgml
1524
1525
1526 <!-- ##### MACRO BEGIN_DECL ##### -->
1527 <para>
1528
1529 </para>
1530
1531
1532 <!-- ##### MACRO CCRITICAL0 ##### -->
1533 <para>
1534
1535 </para>
1536
1537 @c:
1538 @f:
1539
1540 <!-- ##### MACRO CCRITICAL1 ##### -->
1541 <para>
1542
1543 </para>
1544
1545 @c:
1546 @f:
1547 @a1:
1548
1549 <!-- ##### MACRO CCRITICAL2 ##### -->
1550 <para>
1551
1552 </para>
1553
1554 @c:
1555 @f:
1556 @a1:
1557 @a2:
1558
1559 <!-- ##### MACRO CCRITICAL3 ##### -->
1560 <para>
1561
1562 </para>
1563
1564 @c:
1565 @f:
1566 @a1:
1567 @a2:
1568 @a3:
1569
1570 <!-- ##### MACRO CCRITICAL4 ##### -->
1571 <para>
1572
1573 </para>
1574
1575 @c:
1576 @f:
1577 @a1:
1578 @a2:
1579 @a3:
1580 @a4:
1581
1582 <!-- ##### MACRO CCRITICAL5 ##### -->
1583 <para>
1584
1585 </para>
1586
1587 @c:
1588 @f:
1589 @a1:
1590 @a2:
1591 @a3:
1592 @a4:
1593 @a5:
1594
1595 <!-- ##### MACRO CDEBUG0 ##### -->
1596 <para>
1597
1598 </para>
1599
1600 @c:
1601 @f:
1602
1603 <!-- ##### MACRO CDEBUG1 ##### -->
1604 <para>
1605
1606 </para>
1607
1608 @c:
1609 @f:
1610 @a1:
1611
1612 <!-- ##### MACRO CDEBUG2 ##### -->
1613 <para>
1614
1615 </para>
1616
1617 @c:
1618 @f:
1619 @a1:
1620 @a2:
1621
1622 <!-- ##### MACRO CDEBUG3 ##### -->
1623 <para>
1624
1625 </para>
1626
1627 @c:
1628 @f:
1629 @a1:
1630 @a2:
1631 @a3:
1632
1633 <!-- ##### MACRO CDEBUG4 ##### -->
1634 <para>
1635
1636 </para>
1637
1638 @c:
1639 @f:
1640 @a1:
1641 @a2:
1642 @a3:
1643 @a4:
1644
1645 <!-- ##### MACRO CDEBUG5 ##### -->
1646 <para>
1647
1648 </para>
1649
1650 @c:
1651 @f:
1652 @a1:
1653 @a2:
1654 @a3:
1655 @a4:
1656 @a5:
1657
1658 <!-- ##### MACRO CERROR0 ##### -->
1659 <para>
1660
1661 </para>
1662
1663 @c:
1664 @f:
1665
1666 <!-- ##### MACRO CERROR1 ##### -->
1667 <para>
1668
1669 </para>
1670
1671 @c:
1672 @f:
1673 @a1:
1674
1675 <!-- ##### MACRO CERROR2 ##### -->
1676 <para>
1677
1678 </para>
1679
1680 @c:
1681 @f:
1682 @a1:
1683 @a2:
1684
1685 <!-- ##### MACRO CERROR3 ##### -->
1686 <para>
1687
1688 </para>
1689
1690 @c:
1691 @f:
1692 @a1:
1693 @a2:
1694 @a3:
1695
1696 <!-- ##### MACRO CERROR4 ##### -->
1697 <para>
1698
1699 </para>
1700
1701 @c:
1702 @f:
1703 @a1:
1704 @a2:
1705 @a3:
1706 @a4:
1707
1708 <!-- ##### MACRO CERROR5 ##### -->
1709 <para>
1710
1711 </para>
1712
1713 @c:
1714 @f:
1715 @a1:
1716 @a2:
1717 @a3:
1718 @a4:
1719 @a5:
1720
1721 <!-- ##### MACRO CINFO0 ##### -->
1722 <para>
1723
1724 </para>
1725
1726 @c:
1727 @f:
1728
1729 <!-- ##### MACRO CINFO1 ##### -->
1730 <para>
1731
1732 </para>
1733
1734 @c:
1735 @f:
1736 @a1:
1737
1738 <!-- ##### MACRO CINFO2 ##### -->
1739 <para>
1740
1741 </para>
1742
1743 @c:
1744 @f:
1745 @a1:
1746 @a2:
1747
1748 <!-- ##### MACRO CINFO3 ##### -->
1749 <para>
1750
1751 </para>
1752
1753 @c:
1754 @f:
1755 @a1:
1756 @a2:
1757 @a3:
1758
1759 <!-- ##### MACRO CINFO4 ##### -->
1760 <para>
1761
1762 </para>
1763
1764 @c:
1765 @f:
1766 @a1:
1767 @a2:
1768 @a3:
1769 @a4:
1770
1771 <!-- ##### MACRO CINFO5 ##### -->
1772 <para>
1773
1774 </para>
1775
1776 @c:
1777 @f:
1778 @a1:
1779 @a2:
1780 @a3:
1781 @a4:
1782 @a5:
1783
1784 <!-- ##### MACRO CLOG0 ##### -->
1785 <para>
1786
1787 </para>
1788
1789 @c:
1790 @p:
1791 @f:
1792
1793 <!-- ##### MACRO CLOG1 ##### -->
1794 <para>
1795
1796 </para>
1797
1798 @c:
1799 @p:
1800 @f:
1801 @a1:
1802
1803 <!-- ##### MACRO CLOG2 ##### -->
1804 <para>
1805
1806 </para>
1807
1808 @c:
1809 @p:
1810 @f:
1811 @a1:
1812 @a2:
1813
1814 <!-- ##### MACRO CLOG3 ##### -->
1815 <para>
1816
1817 </para>
1818
1819 @c:
1820 @p:
1821 @f:
1822 @a1:
1823 @a2:
1824 @a3:
1825
1826 <!-- ##### MACRO CLOG4 ##### -->
1827 <para>
1828
1829 </para>
1830
1831 @c:
1832 @p:
1833 @f:
1834 @a1:
1835 @a2:
1836 @a3:
1837 @a4:
1838
1839 <!-- ##### MACRO CLOG5 ##### -->
1840 <para>
1841
1842 </para>
1843
1844 @c:
1845 @p:
1846 @f:
1847 @a1:
1848 @a2:
1849 @a3:
1850 @a4:
1851 @a5:
1852
1853 <!-- ##### MACRO CLOG6 ##### -->
1854 <para>
1855
1856 </para>
1857
1858 @c:
1859 @p:
1860 @f:
1861 @a1:
1862 @a2:
1863 @a3:
1864 @a4:
1865 @a5:
1866 @a6:
1867
1868 <!-- ##### MACRO CRITICAL0 ##### -->
1869 <para>
1870
1871 </para>
1872
1873 @f:
1874
1875 <!-- ##### MACRO CRITICAL1 ##### -->
1876 <para>
1877
1878 </para>
1879
1880 @f:
1881 @a1:
1882
1883 <!-- ##### MACRO CRITICAL2 ##### -->
1884 <para>
1885
1886 </para>
1887
1888 @f:
1889 @a1:
1890 @a2:
1891
1892 <!-- ##### MACRO CRITICAL3 ##### -->
1893 <para>
1894
1895 </para>
1896
1897 @f:
1898 @a1:
1899 @a2:
1900 @a3:
1901
1902 <!-- ##### MACRO CRITICAL4 ##### -->
1903 <para>
1904
1905 </para>
1906
1907 @f:
1908 @a1:
1909 @a2:
1910 @a3:
1911 @a4:
1912
1913 <!-- ##### MACRO CRITICAL5 ##### -->
1914 <para>
1915
1916 </para>
1917
1918 @f:
1919 @a1:
1920 @a2:
1921 @a3:
1922 @a4:
1923 @a5:
1924
1925 <!-- ##### MACRO CWARNING6 ##### -->
1926 <para>
1927
1928 </para>
1929
1930 @c:
1931 @f:
1932 @a1:
1933 @a2:
1934 @a3:
1935 @a4:
1936 @a5:
1937 @a6:
1938
1939 <!-- ##### FUNCTION CallAddr ##### -->
1940 <para>
1941
1942 </para>
1943
1944 @addr:
1945 @Param2:
1946 @sock:
1947 @timeOut:
1948 @Returns:
1949
1950 <!-- ##### FUNCTION CloseSocket ##### -->
1951 <para>
1952
1953 </para>
1954
1955 @sock:
1956 @waitForPeer:
1957 @Returns:
1958
1959 <!-- ##### FUNCTION ConvertData ##### -->
1960 <para>
1961
1962 </para>
1963
1964 @destination:
1965 @source:
1966 @description:
1967 @length:
1968 @sourceFormat:
1969
1970 <!-- ##### FUNCTION CreateLocalChild ##### -->
1971 <para>
1972
1973 </para>
1974
1975 @pid:
1976 @parentToChild:
1977 @childToParent:
1978 @Returns:
1979
1980 <!-- ##### FUNCTION DROP_SOCKET ##### -->
1981 <para>
1982
1983 </para>
1984
1985 @sock:
1986 @Returns:
1987
1988 <!-- ##### FUNCTION DataSize ##### -->
1989 <para>
1990
1991 </para>
1992
1993 @description:
1994 @length:
1995 @format:
1996 @Returns:
1997
1998 <!-- ##### ENUM DataTypes ##### -->
1999 <para>
2000
2001 </para>
2002
2003 @CHAR_TYPE:
2004 @DOUBLE_TYPE:
2005 @FLOAT_TYPE:
2006 @INT_TYPE:
2007 @LONG_TYPE:
2008 @SHORT_TYPE:
2009 @UNSIGNED_INT_TYPE:
2010 @UNSIGNED_LONG_TYPE:
2011 @UNSIGNED_SHORT_TYPE:
2012 @STRUCT_TYPE:
2013 @LAST_TYPE:
2014
2015 <!-- ##### FUNCTION DifferentFormat ##### -->
2016 <para>
2017
2018 </para>
2019
2020 @whatType:
2021 @Returns:
2022
2023 <!-- ##### FUNCTION DifferentOrder ##### -->
2024 <para>
2025
2026 </para>
2027
2028 @Returns:
2029
2030 <!-- ##### FUNCTION DifferentSize ##### -->
2031 <para>
2032
2033 </para>
2034
2035 @whatType:
2036 @Returns:
2037
2038 <!-- ##### MACRO END_DECL ##### -->
2039 <para>
2040
2041 </para>
2042
2043
2044 <!-- ##### MACRO EODD ##### -->
2045 <para>
2046
2047 </para>
2048
2049
2050 <!-- ##### FUNCTION EstablishAnEar ##### -->
2051 <para>
2052
2053 </para>
2054
2055 @Param1:
2056 @Param2:
2057 @ear:
2058 @earPort:
2059 @Returns:
2060
2061 <!-- ##### ENUM FormatTypes ##### -->
2062 <para>
2063
2064 </para>
2065
2066 @HOST_FORMAT:
2067 @NETWORK_FORMAT:
2068
2069 <!-- ##### MACRO GRAS_LOG_DEFAULT_CATEGORY ##### -->
2070 <para>
2071
2072 </para>
2073
2074 @cname:
2075
2076 <!-- ##### MACRO GRAS_LOG_EXTERNAL_CATEGORY ##### -->
2077 <para>
2078
2079 </para>
2080
2081 @cname:
2082
2083 <!-- ##### MACRO GRAS_LOG_ISENABLED ##### -->
2084 <para>
2085
2086 </para>
2087
2088 @catName:
2089 @priority:
2090
2091 <!-- ##### MACRO GRAS_LOG_MAYDAY ##### -->
2092 <para>
2093
2094 </para>
2095
2096
2097 <!-- ##### MACRO GRAS_LOG_NEW_CATEGORY ##### -->
2098 <para>
2099
2100 </para>
2101
2102 @catName:
2103 @desc:
2104
2105 <!-- ##### MACRO GRAS_LOG_NEW_DEFAULT_CATEGORY ##### -->
2106 <para>
2107
2108 </para>
2109
2110 @cname:
2111 @desc:
2112
2113 <!-- ##### MACRO GRAS_LOG_NEW_DEFAULT_SUBCATEGORY ##### -->
2114 <para>
2115
2116 </para>
2117
2118 @cname:
2119 @parent:
2120 @desc:
2121
2122 <!-- ##### MACRO GRAS_LOG_NEW_SUBCATEGORY ##### -->
2123 <para>
2124
2125 </para>
2126
2127 @catName:
2128 @parent:
2129 @desc:
2130
2131 <!-- ##### MACRO GRAS_LOG_ROOT_CAT ##### -->
2132 <para>
2133
2134 </para>
2135
2136
2137 <!-- ##### MACRO GRAS_LOG_STATIC_THRESHOLD ##### -->
2138 <para>
2139
2140 </para>
2141
2142
2143 <!-- ##### MACRO HAVE_DLFCN_H ##### -->
2144 <para>
2145
2146 </para>
2147
2148
2149 <!-- ##### MACRO HAVE_INTTYPES_H ##### -->
2150 <para>
2151
2152 </para>
2153
2154
2155 <!-- ##### MACRO HAVE_LIBPTHREAD ##### -->
2156 <para>
2157
2158 </para>
2159
2160
2161 <!-- ##### MACRO HAVE_MEMORY_H ##### -->
2162 <para>
2163
2164 </para>
2165
2166
2167 <!-- ##### MACRO HAVE_STDINT_H ##### -->
2168 <para>
2169
2170 </para>
2171
2172
2173 <!-- ##### MACRO HAVE_STDLIB_H ##### -->
2174 <para>
2175
2176 </para>
2177
2178
2179 <!-- ##### MACRO HAVE_STRINGS_H ##### -->
2180 <para>
2181
2182 </para>
2183
2184
2185 <!-- ##### MACRO HAVE_STRING_H ##### -->
2186 <para>
2187
2188 </para>
2189
2190
2191 <!-- ##### MACRO HAVE_SYS_STAT_H ##### -->
2192 <para>
2193
2194 </para>
2195
2196
2197 <!-- ##### MACRO HAVE_SYS_TYPES_H ##### -->
2198 <para>
2199
2200 </para>
2201
2202
2203 <!-- ##### MACRO HAVE_UNISTD_H ##### -->
2204 <para>
2205
2206 </para>
2207
2208
2209 <!-- ##### FUNCTION HomogenousConvertData ##### -->
2210 <para>
2211
2212 </para>
2213
2214 @destination:
2215 @source:
2216 @whatType:
2217 @repetitions:
2218 @sourceFormat:
2219
2220 <!-- ##### FUNCTION HomogenousDataSize ##### -->
2221 <para>
2222
2223 </para>
2224
2225 @whatType:
2226 @repetitions:
2227 @format:
2228 @Returns:
2229
2230 <!-- ##### TYPEDEF IPAddress ##### -->
2231 <para>
2232
2233 </para>
2234
2235
2236 <!-- ##### FUNCTION IPAddressImage ##### -->
2237 <para>
2238
2239 </para>
2240
2241 @addr:
2242 @Returns:
2243
2244 <!-- ##### FUNCTION IPAddressImage_r ##### -->
2245 <para>
2246
2247 </para>
2248
2249 @addr:
2250 @Returns:
2251
2252 <!-- ##### FUNCTION IPAddressMachine ##### -->
2253 <para>
2254
2255 </para>
2256
2257 @addr:
2258 @Returns:
2259
2260 <!-- ##### FUNCTION IPAddressMachine_r ##### -->
2261 <para>
2262
2263 </para>
2264
2265 @addr:
2266 @Returns:
2267
2268 <!-- ##### MACRO IPAddressValue ##### -->
2269 <para>
2270
2271 </para>
2272
2273 @machineOrAddress:
2274 @address:
2275
2276 <!-- ##### FUNCTION IPAddressValues ##### -->
2277 <para>
2278
2279 </para>
2280
2281 @machineOrAddress:
2282 @addressList:
2283 @atMost:
2284 @Returns:
2285
2286 <!-- ##### FUNCTION IncomingRequest ##### -->
2287 <para>
2288
2289 </para>
2290
2291 @timeOut:
2292 @sd:
2293 @ldap:
2294 @Returns:
2295
2296 <!-- ##### FUNCTION IsOkay ##### -->
2297 <para>
2298
2299 </para>
2300
2301 @sd:
2302 @Returns:
2303
2304 <!-- ##### FUNCTION IsPipe ##### -->
2305 <para>
2306
2307 </para>
2308
2309 @sd:
2310 @Returns:
2311
2312 <!-- ##### MACRO IsValidIP ##### -->
2313 <para>
2314
2315 </para>
2316
2317 @machineOrAddress:
2318
2319 <!-- ##### MACRO LOG6 ##### -->
2320 <para>
2321
2322 </para>
2323
2324 @p:
2325 @f:
2326 @a1:
2327 @a2:
2328 @a3:
2329 @a4:
2330 @a5:
2331 @a6:
2332
2333 <!-- ##### FUNCTION MyMachineName ##### -->
2334 <para>
2335
2336 </para>
2337
2338 @Returns:
2339
2340 <!-- ##### MACRO NO_SOCKET ##### -->
2341 <para>
2342
2343 </para>
2344
2345
2346 <!-- ##### FUNCTION NotifyOnDisconnection ##### -->
2347 <para>
2348
2349 </para>
2350
2351 @notifyFn:
2352
2353 <!-- ##### FUNCTION OpenClientSocket ##### -->
2354 <para>
2355
2356 </para>
2357
2358 @addr:
2359 @Param2:
2360 @sock:
2361 @Returns:
2362
2363 <!-- ##### FUNCTION OpenServerSocket ##### -->
2364 <para>
2365
2366 </para>
2367
2368 @Param1:
2369 @Param2:
2370 @ear:
2371 @earPort:
2372 @Returns:
2373
2374 <!-- ##### MACRO PACKAGE ##### -->
2375 <para>
2376
2377 </para>
2378
2379
2380 <!-- ##### MACRO PACKAGE_BUGREPORT ##### -->
2381 <para>
2382
2383 </para>
2384
2385
2386 <!-- ##### MACRO PACKAGE_NAME ##### -->
2387 <para>
2388
2389 </para>
2390
2391
2392 <!-- ##### MACRO PACKAGE_STRING ##### -->
2393 <para>
2394
2395 </para>
2396
2397
2398 <!-- ##### MACRO PACKAGE_TARNAME ##### -->
2399 <para>
2400
2401 </para>
2402
2403
2404 <!-- ##### MACRO PACKAGE_VERSION ##### -->
2405 <para>
2406
2407 </para>
2408
2409
2410 <!-- ##### MACRO PAD_BYTES ##### -->
2411 <para>
2412
2413 </para>
2414
2415 @structType:
2416 @lastMember:
2417 @memberType:
2418 @repetitions:
2419
2420 <!-- ##### FUNCTION PassSocket ##### -->
2421 <para>
2422
2423 </para>
2424
2425 @sock:
2426 @child:
2427 @Returns:
2428
2429 <!-- ##### FUNCTION Peer ##### -->
2430 <para>
2431
2432 </para>
2433
2434 @sd:
2435 @Returns:
2436
2437 <!-- ##### FUNCTION PeerName ##### -->
2438 <para>
2439
2440 </para>
2441
2442 @sd:
2443 @Returns:
2444
2445 <!-- ##### FUNCTION PeerName_r ##### -->
2446 <para>
2447
2448 </para>
2449
2450 @sd:
2451 @Returns:
2452
2453 <!-- ##### FUNCTION ReverseData ##### -->
2454 <para>
2455
2456 </para>
2457
2458 @destination:
2459 @source:
2460 @whatType:
2461 @repetitions:
2462 @format:
2463
2464 <!-- ##### MACRO SIMPLE_DATA ##### -->
2465 <para>
2466
2467 </para>
2468
2469 @type:
2470 @repetitions:
2471
2472 <!-- ##### MACRO SIMPLE_MEMBER ##### -->
2473 <para>
2474
2475 </para>
2476
2477 @type:
2478 @repetitions:
2479 @offset:
2480
2481 <!-- ##### MACRO SIMPLE_TYPE_COUNT ##### -->
2482 <para>
2483
2484 </para>
2485
2486
2487 <!-- ##### MACRO STDC_HEADERS ##### -->
2488 <para>
2489
2490 </para>
2491
2492
2493 <!-- ##### TYPEDEF Socket ##### -->
2494 <para>
2495
2496 </para>
2497
2498
2499 <!-- ##### FUNCTION SocketFailure ##### -->
2500 <para>
2501
2502 </para>
2503
2504 @sig:
2505
2506 <!-- ##### USER_FUNCTION SocketFunction ##### -->
2507 <para>
2508
2509 </para>
2510
2511 @Param1:
2512
2513 <!-- ##### FUNCTION SocketInUse ##### -->
2514 <para>
2515
2516 </para>
2517
2518 @sd:
2519 @Returns:
2520
2521 <!-- ##### FUNCTION SocketIsAvailable ##### -->
2522 <para>
2523
2524 </para>
2525
2526 @sd:
2527 @Returns:
2528
2529 <!-- ##### MACRO VERSION ##### -->
2530 <para>
2531
2532 </para>
2533
2534
2535 <!-- ##### MACRO WARNING6 ##### -->
2536 <para>
2537
2538 </para>
2539
2540 @f:
2541 @a1:
2542 @a2:
2543 @a3:
2544 @a4:
2545 @a5:
2546 @a6:
2547
2548 <!-- ##### USER_FUNCTION grasCallbackFunction ##### -->
2549 <para>
2550
2551 </para>
2552
2553 @sd:
2554 @msgType:
2555 @vdata:
2556
2557 <!-- ##### FUNCTION grasCloseSocket ##### -->
2558 <para>
2559
2560 </para>
2561
2562 @sock:
2563 @Returns:
2564
2565 <!-- ##### FUNCTION grasDataDescCmp ##### -->
2566 <para>
2567
2568 </para>
2569
2570 @dd1:
2571 @c1:
2572 @dd2:
2573 @c2:
2574 @Returns:
2575 @description:
2576
2577 <!-- ##### FUNCTION grasDataDescCount ##### -->
2578 <para>
2579
2580 </para>
2581
2582 @description:
2583 @Returns:
2584
2585 <!-- ##### FUNCTION grasDataRecv ##### -->
2586 <para>
2587
2588 </para>
2589
2590 @sd:
2591 @data:
2592 @description:
2593 @description_length:
2594 @repetition:
2595 @Returns:
2596
2597 <!-- ##### FUNCTION grasDataSend ##### -->
2598 <para>
2599
2600 </para>
2601
2602 @sd:
2603 @data:
2604 @description:
2605 @description_length:
2606 @repetition:
2607 @Returns:
2608
2609 <!-- ##### FUNCTION grasDataSize ##### -->
2610 <para>
2611
2612 </para>
2613
2614 @description:
2615 @ft:
2616 @Returns:
2617
2618 <!-- ##### ENUM grasError_t ##### -->
2619 <para>
2620
2621 </para>
2622
2623 @no_error:
2624 @malloc_error:
2625 @mismatch_error:
2626 @sanity_error:
2627 @system_error:
2628 @network_error:
2629 @timeout_error:
2630 @thread_error:
2631 @unknown_error:
2632
2633 <!-- ##### FUNCTION grasLock ##### -->
2634 <para>
2635
2636 </para>
2637
2638 @Returns:
2639
2640 <!-- ##### TYPEDEF grasMessageType_t ##### -->
2641 <para>
2642
2643 </para>
2644
2645
2646 <!-- ##### FUNCTION grasMsgDiscard ##### -->
2647 <para>
2648
2649 </para>
2650
2651 @sd:
2652 @size:
2653
2654 <!-- ##### FUNCTION grasMsgEntryGet ##### -->
2655 <para>
2656
2657 </para>
2658
2659 @id:
2660 @Returns:
2661
2662 <!-- ##### TYPEDEF grasMsgEntry_t ##### -->
2663 <para>
2664
2665 </para>
2666
2667
2668 <!-- ##### FUNCTION grasMsgFree ##### -->
2669 <para>
2670
2671 </para>
2672
2673 @msg:
2674
2675 <!-- ##### FUNCTION grasMsgHandle ##### -->
2676 <para>
2677
2678 </para>
2679
2680 @timeOut:
2681
2682 <!-- ##### FUNCTION grasMsgHeaderNew ##### -->
2683 <para>
2684
2685 </para>
2686
2687 @msgId:
2688 @dataSize:
2689 @seqCount:
2690 @Returns:
2691
2692 <!-- ##### FUNCTION grasMsgNew ##### -->
2693 <para>
2694
2695 </para>
2696
2697 @msgId:
2698 @free_data_on_free:
2699 @seqCount:
2700 @Varargs:
2701 @Returns:
2702
2703 <!-- ##### FUNCTION grasMsgRecv ##### -->
2704 <para>
2705
2706 </para>
2707
2708 @msg:
2709 @timeout:
2710 @Returns:
2711 @sd:
2712
2713 <!-- ##### FUNCTION grasMsgRegister ##### -->
2714 <para>
2715
2716 </para>
2717
2718 @message:
2719 @name:
2720 @sequence_count:
2721 @Varargs:
2722 @Returns:
2723
2724 <!-- ##### FUNCTION grasMsgSend ##### -->
2725 <para>
2726
2727 </para>
2728
2729 @sd:
2730 @message:
2731 @sequence_count:
2732 @Varargs:
2733 @Returns:
2734
2735 <!-- ##### FUNCTION grasMsgWait ##### -->
2736 <para>
2737
2738 </para>
2739
2740 @sd:
2741 @timeout:
2742 @message:
2743 @sequence_count:
2744 @Varargs:
2745 @Returns:
2746
2747 <!-- ##### FUNCTION grasMyMachineName ##### -->
2748 <para>
2749
2750 </para>
2751
2752 @Returns:
2753
2754 <!-- ##### FUNCTION grasOpenClientSocket ##### -->
2755 <para>
2756
2757 </para>
2758
2759 @host:
2760 @Param2:
2761 @sock:
2762 @Returns:
2763
2764 <!-- ##### FUNCTION grasOpenServerSocket ##### -->
2765 <para>
2766
2767 </para>
2768
2769 @Param1:
2770 @Param2:
2771 @sock:
2772 @Returns:
2773
2774 <!-- ##### MACRO grasPROTOCOL ##### -->
2775 <para>
2776
2777 </para>
2778
2779
2780 <!-- ##### FUNCTION grasPeerGetAddress ##### -->
2781 <para>
2782
2783 </para>
2784
2785 @sd:
2786 @Returns:
2787
2788 <!-- ##### FUNCTION grasPeerGetName ##### -->
2789 <para>
2790
2791 </para>
2792
2793 @sd:
2794 @Returns:
2795
2796 <!-- ##### FUNCTION grasRecvData ##### -->
2797 <para>
2798
2799 </para>
2800
2801 @sd:
2802 @data:
2803 @description:
2804 @Returns:
2805
2806 <!-- ##### FUNCTION grasRegisterCallback ##### -->
2807 <para>
2808
2809 </para>
2810
2811 @message:
2812 @TTL:
2813 @cb:
2814
2815 <!-- ##### FUNCTION grasSendData ##### -->
2816 <para>
2817
2818 </para>
2819
2820 @sd:
2821 @data:
2822 @description:
2823 @Returns:
2824
2825 <!-- ##### FUNCTION grasUnlock ##### -->
2826 <para>
2827
2828 </para>
2829
2830 @Returns:
2831
2832 <!-- ##### FUNCTION grasUserdataGet ##### -->
2833 <para>
2834
2835 </para>
2836
2837
2838 <!-- ##### MACRO grasUserdataNew ##### -->
2839 <para>
2840
2841 </para>
2842
2843 @type:
2844
2845 <!-- ##### FUNCTION grasUserdataSet ##### -->
2846 <para>
2847
2848 </para>
2849
2850 @ud:
2851
2852 <!-- ##### FUNCTION gras_cfg_check ##### -->
2853 <para>
2854
2855 </para>
2856
2857 @cfg:
2858 @Returns:
2859
2860 <!-- ##### FUNCTION gras_cfg_cpy ##### -->
2861 <para>
2862
2863 </para>
2864
2865 @tocopy:
2866 @whereto:
2867 @Returns:
2868
2869 <!-- ##### FUNCTION gras_cfg_dump ##### -->
2870 <para>
2871
2872 </para>
2873
2874 @name:
2875 @indent:
2876 @cfg:
2877
2878 <!-- ##### FUNCTION gras_cfg_empty ##### -->
2879 <para>
2880
2881 </para>
2882
2883 @cfg:
2884 @name:
2885 @Returns:
2886
2887 <!-- ##### FUNCTION gras_cfg_free ##### -->
2888 <para>
2889
2890 </para>
2891
2892 @cfg:
2893
2894 <!-- ##### FUNCTION gras_cfg_get_double ##### -->
2895 <para>
2896
2897 </para>
2898
2899 @cfg:
2900 @name:
2901 @val:
2902 @Returns:
2903
2904 <!-- ##### FUNCTION gras_cfg_get_dynar ##### -->
2905 <para>
2906
2907 </para>
2908
2909 @cfg:
2910 @name:
2911 @dynar:
2912 @Returns:
2913
2914 <!-- ##### FUNCTION gras_cfg_get_host ##### -->
2915 <para>
2916
2917 </para>
2918
2919 @cfg:
2920 @name:
2921 @host:
2922 @port:
2923 @Returns:
2924
2925 <!-- ##### FUNCTION gras_cfg_get_int ##### -->
2926 <para>
2927
2928 </para>
2929
2930 @cfg:
2931 @name:
2932 @val:
2933 @Returns:
2934
2935 <!-- ##### FUNCTION gras_cfg_get_string ##### -->
2936 <para>
2937
2938 </para>
2939
2940 @cfg:
2941 @name:
2942 @val:
2943 @Returns:
2944
2945 <!-- ##### FUNCTION gras_cfg_new ##### -->
2946 <para>
2947
2948 </para>
2949
2950 @Returns:
2951 @whereto:
2952
2953 <!-- ##### FUNCTION gras_cfg_register ##### -->
2954 <para>
2955
2956 </para>
2957
2958 @cfg:
2959 @name:
2960 @type:
2961 @min:
2962 @max:
2963 @Returns:
2964
2965 <!-- ##### FUNCTION gras_cfg_register_str ##### -->
2966 <para>
2967
2968 </para>
2969
2970 @cfg:
2971 @entry:
2972 @Returns:
2973
2974 <!-- ##### FUNCTION gras_cfg_rm_double ##### -->
2975 <para>
2976
2977 </para>
2978
2979 @cfg:
2980 @name:
2981 @val:
2982 @Returns:
2983
2984 <!-- ##### FUNCTION gras_cfg_rm_host ##### -->
2985 <para>
2986
2987 </para>
2988
2989 @cfg:
2990 @name:
2991 @host:
2992 @port:
2993 @Returns:
2994
2995 <!-- ##### FUNCTION gras_cfg_rm_int ##### -->
2996 <para>
2997
2998 </para>
2999
3000 @cfg:
3001 @name:
3002 @val:
3003 @Returns:
3004
3005 <!-- ##### FUNCTION gras_cfg_rm_string ##### -->
3006 <para>
3007
3008 </para>
3009
3010 @cfg:
3011 @name:
3012 @val:
3013 @Returns:
3014
3015 <!-- ##### FUNCTION gras_cfg_set ##### -->
3016 <para>
3017
3018 </para>
3019
3020 @cfg:
3021 @Varargs:
3022 @Returns:
3023
3024 <!-- ##### FUNCTION gras_cfg_set_double ##### -->
3025 <para>
3026
3027 </para>
3028
3029 @cfg:
3030 @name:
3031 @val:
3032 @Returns:
3033
3034 <!-- ##### FUNCTION gras_cfg_set_host ##### -->
3035 <para>
3036
3037 </para>
3038
3039 @cfg:
3040 @name:
3041 @host:
3042 @port:
3043 @Returns:
3044
3045 <!-- ##### FUNCTION gras_cfg_set_int ##### -->
3046 <para>
3047
3048 </para>
3049
3050 @cfg:
3051 @name:
3052 @val:
3053 @Returns:
3054
3055 <!-- ##### FUNCTION gras_cfg_set_parse ##### -->
3056 <para>
3057
3058 </para>
3059
3060 @cfg:
3061 @options:
3062 @Returns:
3063
3064 <!-- ##### FUNCTION gras_cfg_set_string ##### -->
3065 <para>
3066
3067 </para>
3068
3069 @cfg:
3070 @name:
3071 @val:
3072 @Returns:
3073
3074 <!-- ##### FUNCTION gras_cfg_set_vargs ##### -->
3075 <para>
3076
3077 </para>
3078
3079 @cfg:
3080 @pa:
3081 @Returns:
3082
3083 <!-- ##### FUNCTION gras_datadesc_cb_set_post ##### -->
3084 <para>
3085
3086 </para>
3087
3088 @type:
3089 @post:
3090
3091 <!-- ##### FUNCTION gras_datadesc_cb_set_pre ##### -->
3092 <para>
3093
3094 </para>
3095
3096 @type:
3097 @pre:
3098
3099 <!-- ##### FUNCTION gras_datadesc_cmp ##### -->
3100 <para>
3101
3102 </para>
3103
3104 @d1:
3105 @d2:
3106 @Returns:
3107 @dd1:
3108 @c1:
3109 @dd2:
3110 @c2:
3111
3112 <!-- ##### FUNCTION gras_datadesc_copy_data ##### -->
3113 <para>
3114
3115 </para>
3116
3117 @dd:
3118 @c:
3119 @data:
3120
3121 <!-- ##### MACRO gras_datadesc_declare_array ##### -->
3122 <para>
3123
3124 </para>
3125
3126 @name:
3127 @elm_type:
3128 @size:
3129 @code:
3130
3131 <!-- ##### FUNCTION gras_datadesc_declare_array_cb ##### -->
3132 <para>
3133
3134 </para>
3135
3136 @name:
3137 @element_type:
3138 @fixed_size:
3139 @dynamic_size:
3140 @post:
3141 @code:
3142 @Returns:
3143
3144 <!-- ##### FUNCTION gras_datadesc_declare_array_dyn ##### -->
3145 <para>
3146
3147 </para>
3148
3149 @name:
3150 @element_type:
3151 @dynamic_size:
3152 @dst:
3153 @Returns:
3154 @elm_type:
3155 @code:
3156
3157 <!-- ##### FUNCTION gras_datadesc_declare_array_fixed ##### -->
3158 <para>
3159
3160 </para>
3161
3162 @name:
3163 @element_type:
3164 @fixed_size:
3165 @dst:
3166 @Returns:
3167
3168 <!-- ##### FUNCTION gras_datadesc_declare_ref ##### -->
3169 <para>
3170
3171 </para>
3172
3173 @name:
3174 @referenced_type:
3175 @dst:
3176 @Returns:
3177 @ref_type:
3178 @code:
3179
3180 <!-- ##### FUNCTION gras_datadesc_declare_ref_cb ##### -->
3181 <para>
3182
3183 </para>
3184
3185 @name:
3186 @referenced_type:
3187 @discriminant:
3188 @post:
3189 @code:
3190 @Returns:
3191
3192 <!-- ##### MACRO gras_datadesc_declare_ref_disc ##### -->
3193 <para>
3194
3195 </para>
3196
3197 @name:
3198 @discriminant:
3199 @code:
3200
3201 <!-- ##### FUNCTION gras_datadesc_declare_ref_generic ##### -->
3202 <para>
3203
3204 </para>
3205
3206 @name:
3207 @discriminant:
3208 @dst:
3209 @Returns:
3210
3211 <!-- ##### FUNCTION gras_datadesc_declare_struct ##### -->
3212 <para>
3213
3214 </para>
3215
3216 @name:
3217 @dst:
3218 @Returns:
3219 @code:
3220
3221 <!-- ##### MACRO gras_datadesc_declare_struct_add_code ##### -->
3222 <para>
3223
3224 </para>
3225
3226 @struct_code:
3227 @field_name:
3228 @field_type_code:
3229
3230 <!-- ##### FUNCTION gras_datadesc_declare_struct_add_code_cb ##### -->
3231 <para>
3232
3233 </para>
3234
3235 @struct_code:
3236 @field_name:
3237 @field_code:
3238 @pre_cb:
3239 @post_cb:
3240 @Returns:
3241
3242 <!-- ##### MACRO gras_datadesc_declare_struct_add_name ##### -->
3243 <para>
3244
3245 </para>
3246
3247 @struct_code:
3248 @field_name:
3249 @field_type_name:
3250
3251 <!-- ##### FUNCTION gras_datadesc_declare_struct_add_name_cb ##### -->
3252 <para>
3253
3254 </para>
3255
3256 @struct_code:
3257 @field_name:
3258 @field_type_name:
3259 @pre_cb:
3260 @post_cb:
3261 @Returns:
3262
3263 <!-- ##### FUNCTION gras_datadesc_declare_struct_append ##### -->
3264 <para>
3265
3266 </para>
3267
3268 @struct_type:
3269 @name:
3270 @field_type:
3271 @Returns:
3272
3273 <!-- ##### FUNCTION gras_datadesc_declare_struct_append_name ##### -->
3274 <para>
3275
3276 </para>
3277
3278 @struct_type:
3279 @name:
3280 @field_type_name:
3281 @Returns:
3282
3283 <!-- ##### FUNCTION gras_datadesc_declare_struct_cb ##### -->
3284 <para>
3285
3286 </para>
3287
3288 @name:
3289 @pre_cb:
3290 @post_cb:
3291 @code:
3292 @Returns:
3293
3294 <!-- ##### FUNCTION gras_datadesc_declare_struct_close ##### -->
3295 <para>
3296
3297 </para>
3298
3299 @struct_type:
3300
3301 <!-- ##### FUNCTION gras_datadesc_declare_union ##### -->
3302 <para>
3303
3304 </para>
3305
3306 @name:
3307 @selector:
3308 @dst:
3309 @Returns:
3310 @code:
3311
3312 <!-- ##### MACRO gras_datadesc_declare_union_add_code ##### -->
3313 <para>
3314
3315 </para>
3316
3317 @union_code:
3318 @field_name:
3319 @field_type_code:
3320
3321 <!-- ##### FUNCTION gras_datadesc_declare_union_add_code_cb ##### -->
3322 <para>
3323
3324 </para>
3325
3326 @union_code:
3327 @field_name:
3328 @field_code:
3329 @pre_cb:
3330 @post_cb:
3331 @Returns:
3332
3333 <!-- ##### MACRO gras_datadesc_declare_union_add_name ##### -->
3334 <para>
3335
3336 </para>
3337
3338 @union_code:
3339 @field_name:
3340 @field_type_name:
3341
3342 <!-- ##### FUNCTION gras_datadesc_declare_union_add_name_cb ##### -->
3343 <para>
3344
3345 </para>
3346
3347 @union_code:
3348 @field_name:
3349 @field_type_name:
3350 @pre_cb:
3351 @post_cb:
3352 @Returns:
3353
3354 <!-- ##### FUNCTION gras_datadesc_declare_union_append ##### -->
3355 <para>
3356
3357 </para>
3358
3359 @union_type:
3360 @name:
3361 @field_type:
3362 @Returns:
3363
3364 <!-- ##### FUNCTION gras_datadesc_declare_union_append_name ##### -->
3365 <para>
3366
3367 </para>
3368
3369 @union_type:
3370 @name:
3371 @field_type_name:
3372 @Returns:
3373
3374 <!-- ##### FUNCTION gras_datadesc_declare_union_cb ##### -->
3375 <para>
3376
3377 </para>
3378
3379 @name:
3380 @field_count:
3381 @post:
3382 @code:
3383 @Returns:
3384
3385 <!-- ##### FUNCTION gras_datadesc_declare_union_close ##### -->
3386 <para>
3387
3388 </para>
3389
3390 @union_type:
3391
3392 <!-- ##### FUNCTION gras_datadesc_from_nws ##### -->
3393 <para>
3394
3395 </para>
3396
3397 @name:
3398 @desc:
3399 @howmany:
3400 @code:
3401 @Returns:
3402 @dst:
3403
3404 <!-- ##### FUNCTION gras_datadesc_import_nws ##### -->
3405 <para>
3406
3407 </para>
3408
3409 @name:
3410 @desc:
3411 @howmany:
3412 @dst:
3413 @Returns:
3414
3415 <!-- ##### FUNCTION gras_datadesc_parse ##### -->
3416 <para>
3417
3418 </para>
3419
3420 @name:
3421 @Cdefinition:
3422 @dst:
3423 @Returns:
3424 @code:
3425 @def:
3426
3427 <!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
3428 <para>
3429
3430 </para>
3431
3432 @ps:
3433
3434 <!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
3435 <para>
3436
3437 </para>
3438
3439 @ps:
3440
3441 <!-- ##### FUNCTION gras_dd_cbps_get ##### -->
3442 <para>
3443
3444 </para>
3445
3446 @ps:
3447 @name:
3448 @ddt:
3449
3450 <!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
3451 <para>
3452
3453 </para>
3454
3455 @ps:
3456 @name:
3457 @ddt:
3458
3459 <!-- ##### FUNCTION gras_dd_cbps_push ##### -->
3460 <para>
3461
3462 </para>
3463
3464 @ps:
3465 @name:
3466 @data:
3467 @ddt:
3468
3469 <!-- ##### FUNCTION gras_dd_cbps_set ##### -->
3470 <para>
3471
3472 </para>
3473
3474 @ps:
3475 @name:
3476 @data:
3477 @ddt:
3478
3479 <!-- ##### FUNCTION gras_ddt_free ##### -->
3480 <para>
3481
3482 </para>
3483
3484 @type:
3485
3486 <!-- ##### FUNCTION gras_ddt_get_by_code ##### -->
3487 <para>
3488
3489 </para>
3490
3491 @code:
3492 @type:
3493 @Returns:
3494
3495 <!-- ##### FUNCTION gras_ddt_get_by_name ##### -->
3496 <para>
3497
3498 </para>
3499
3500 @name:
3501 @type:
3502 @Returns:
3503
3504 <!-- ##### FUNCTION gras_ddt_new_array ##### -->
3505 <para>
3506
3507 </para>
3508
3509 @name:
3510 @element_type:
3511 @fixed_size:
3512 @dynamic_size:
3513 @post:
3514 @dst:
3515 @Returns:
3516
3517 <!-- ##### FUNCTION gras_ddt_new_from_nws ##### -->
3518 <para>
3519
3520 </para>
3521
3522 @name:
3523 @desc:
3524 @howmany:
3525 @dst:
3526 @Returns:
3527
3528 <!-- ##### FUNCTION gras_ddt_new_ignored ##### -->
3529 <para>
3530
3531 </para>
3532
3533 @name:
3534 @default_value:
3535 @free_func:
3536 @size:
3537 @alignment:
3538 @post:
3539 @dst:
3540 @Returns:
3541
3542 <!-- ##### FUNCTION gras_ddt_new_parse ##### -->
3543 <para>
3544
3545 </para>
3546
3547 @name:
3548 @C_definition:
3549 @dst:
3550 @Returns:
3551
3552 <!-- ##### FUNCTION gras_ddt_new_ref ##### -->
3553 <para>
3554
3555 </para>
3556
3557 @name:
3558 @referenced_type:
3559 @discriminant:
3560 @post:
3561 @dst:
3562 @Returns:
3563
3564 <!-- ##### FUNCTION gras_ddt_new_scalar ##### -->
3565 <para>
3566
3567 </para>
3568
3569 @name:
3570 @type:
3571 @Returns:
3572
3573 <!-- ##### FUNCTION gras_ddt_new_struct ##### -->
3574 <para>
3575
3576 </para>
3577
3578 @name:
3579 @pre:
3580 @post:
3581 @dst:
3582 @Returns:
3583
3584 <!-- ##### FUNCTION gras_ddt_new_struct_append ##### -->
3585 <para>
3586
3587 </para>
3588
3589 @struct_type:
3590 @name:
3591 @field_type:
3592 @pre:
3593 @post:
3594 @Returns:
3595
3596 <!-- ##### FUNCTION gras_ddt_new_union ##### -->
3597 <para>
3598
3599 </para>
3600
3601 @name:
3602 @field_count:
3603 @post:
3604 @dst:
3605 @Returns:
3606
3607 <!-- ##### FUNCTION gras_ddt_new_union_append ##### -->
3608 <para>
3609
3610 </para>
3611
3612 @union_type:
3613 @name:
3614 @field_type:
3615 @pre:
3616 @post:
3617 @Returns:
3618
3619 <!-- ##### FUNCTION gras_ddt_register ##### -->
3620 <para>
3621
3622 </para>
3623
3624 @type:
3625 @Returns:
3626
3627 <!-- ##### FUNCTION gras_dict_cursor_free ##### -->
3628 <para>
3629
3630 </para>
3631
3632 @cursor:
3633 @Returns:
3634
3635 <!-- ##### FUNCTION gras_dict_cursor_get_data ##### -->
3636 <para>
3637
3638 </para>
3639
3640 @cursor:
3641 @data:
3642 @Returns:
3643
3644 <!-- ##### FUNCTION gras_dict_cursor_get_key ##### -->
3645 <para>
3646
3647 </para>
3648
3649 @cursor:
3650 @key:
3651 @Returns:
3652
3653 <!-- ##### FUNCTION gras_dict_cursor_new ##### -->
3654 <para>
3655
3656 </para>
3657
3658 @head:
3659 @Returns:
3660 @cursor:
3661
3662 <!-- ##### FUNCTION gras_dict_cursor_next ##### -->
3663 <para>
3664
3665 </para>
3666
3667 @cursor:
3668 @Returns:
3669
3670 <!-- ##### FUNCTION gras_dict_cursor_rewind ##### -->
3671 <para>
3672
3673 </para>
3674
3675 @cursor:
3676 @Returns:
3677
3678 <!-- ##### FUNCTION gras_dict_dump ##### -->
3679 <para>
3680
3681 </para>
3682
3683 @head:
3684 @output:
3685 @Returns:
3686
3687 <!-- ##### MACRO gras_dict_foreach ##### -->
3688 <para>
3689
3690 </para>
3691
3692 @dict:
3693 @cursor:
3694 @key:
3695 @data:
3696
3697 <!-- ##### FUNCTION gras_dict_free ##### -->
3698 <para>
3699
3700 </para>
3701
3702 @dict:
3703 @Returns:
3704
3705 <!-- ##### FUNCTION gras_dict_get ##### -->
3706 <para>
3707
3708 </para>
3709
3710 @head:
3711 @key:
3712 @data:
3713 @Returns:
3714
3715 <!-- ##### FUNCTION gras_dict_get_ext ##### -->
3716 <para>
3717
3718 </para>
3719
3720 @head:
3721 @key:
3722 @key_len:
3723 @data:
3724 @Returns:
3725
3726 <!-- ##### FUNCTION gras_dict_insert ##### -->
3727 <para>
3728
3729 </para>
3730
3731 @head:
3732 @key:
3733 @data:
3734 @free_ctn:
3735 @Returns:
3736
3737 <!-- ##### FUNCTION gras_dict_insert_ext ##### -->
3738 <para>
3739
3740 </para>
3741
3742 @head:
3743 @key:
3744 @key_len:
3745 @data:
3746 @free_ctn:
3747 @Returns:
3748
3749 <!-- ##### FUNCTION gras_dict_new ##### -->
3750 <para>
3751
3752 </para>
3753
3754 @Returns:
3755 @dict:
3756
3757 <!-- ##### FUNCTION gras_dict_print ##### -->
3758 <para>
3759
3760 </para>
3761
3762 @data:
3763
3764 <!-- ##### FUNCTION gras_dict_prints ##### -->
3765 <para>
3766
3767 </para>
3768
3769 @data:
3770
3771 <!-- ##### FUNCTION gras_dict_remove ##### -->
3772 <para>
3773
3774 </para>
3775
3776 @head:
3777 @key:
3778 @Returns:
3779
3780 <!-- ##### FUNCTION gras_dict_remove_ext ##### -->
3781 <para>
3782
3783 </para>
3784
3785 @head:
3786 @key:
3787 @key_len:
3788 @Returns:
3789
3790 <!-- ##### FUNCTION gras_dict_retrieve ##### -->
3791 <para>
3792
3793 </para>
3794
3795 @head:
3796 @key:
3797 @data:
3798 @Returns:
3799
3800 <!-- ##### FUNCTION gras_dict_retrieve_ext ##### -->
3801 <para>
3802
3803 </para>
3804
3805 @head:
3806 @key:
3807 @key_len:
3808 @data:
3809 @Returns:
3810
3811 <!-- ##### FUNCTION gras_dict_set ##### -->
3812 <para>
3813
3814 </para>
3815
3816 @head:
3817 @key:
3818 @data:
3819 @free_ctn:
3820 @Returns:
3821
3822 <!-- ##### FUNCTION gras_dict_set_ext ##### -->
3823 <para>
3824
3825 </para>
3826
3827 @head:
3828 @key:
3829 @key_len:
3830 @data:
3831 @free_ctn:
3832 @Returns:
3833
3834 <!-- ##### FUNCTION gras_dynar_cursor_first ##### -->
3835 <para>
3836
3837 </para>
3838
3839 @dynar:
3840 @cursor:
3841
3842 <!-- ##### FUNCTION gras_dynar_cursor_get ##### -->
3843 <para>
3844
3845 </para>
3846
3847 @dynar:
3848 @cursor:
3849 @whereto:
3850 @Returns:
3851
3852 <!-- ##### FUNCTION gras_dynar_cursor_rm ##### -->
3853 <para>
3854
3855 </para>
3856
3857 @dynar:
3858 @cursor:
3859
3860 <!-- ##### FUNCTION gras_dynar_cursor_step ##### -->
3861 <para>
3862
3863 </para>
3864
3865 @dynar:
3866 @cursor:
3867
3868 <!-- ##### FUNCTION gras_dynar_first ##### -->
3869 <para>
3870
3871 </para>
3872
3873 @dynar:
3874 @cursor:
3875 @Returns:
3876
3877 <!-- ##### MACRO gras_dynar_foreach ##### -->
3878 <para>
3879
3880 </para>
3881
3882 @_dynar:
3883 @_cursor:
3884 @_data:
3885 @_whereto:
3886
3887 <!-- ##### FUNCTION gras_dynar_free ##### -->
3888 <para>
3889
3890 </para>
3891
3892 @dynar:
3893 @Returns:
3894
3895 <!-- ##### FUNCTION gras_dynar_free_container ##### -->
3896 <para>
3897
3898 </para>
3899
3900 @dynar:
3901 @Returns:
3902
3903 <!-- ##### FUNCTION gras_dynar_get ##### -->
3904 <para>
3905
3906 </para>
3907
3908 @dynar:
3909 @idx:
3910 @dst:
3911 @whereto:
3912 @Returns:
3913
3914 <!-- ##### FUNCTION gras_dynar_insert_at ##### -->
3915 <para>
3916
3917 </para>
3918
3919 @dynar:
3920 @idx:
3921 @src:
3922 @Returns:
3923 @object:
3924
3925 <!-- ##### FUNCTION gras_dynar_length ##### -->
3926 <para>
3927
3928 </para>
3929
3930 @dynar:
3931 @Returns:
3932
3933 <!-- ##### FUNCTION gras_dynar_map ##### -->
3934 <para>
3935
3936 </para>
3937
3938 @dynar:
3939 @operator:
3940 @Returns:
3941
3942 <!-- ##### FUNCTION gras_dynar_new ##### -->
3943 <para>
3944
3945 </para>
3946
3947 @Param1:
3948 @free_func:
3949 @Returns:
3950 @whereto:
3951 @elm_size:
3952
3953 <!-- ##### FUNCTION gras_dynar_next ##### -->
3954 <para>
3955
3956 </para>
3957
3958 @dynar:
3959 @cursor:
3960 @whereto:
3961 @Returns:
3962
3963 <!-- ##### FUNCTION gras_dynar_pop ##### -->
3964 <para>
3965
3966 </para>
3967
3968 @dynar:
3969 @dst:
3970 @whereto:
3971
3972 <!-- ##### FUNCTION gras_dynar_push ##### -->
3973 <para>
3974
3975 </para>
3976
3977 @dynar:
3978 @src:
3979 @Returns:
3980 @object:
3981
3982 <!-- ##### FUNCTION gras_dynar_remove_at ##### -->
3983 <para>
3984
3985 </para>
3986
3987 @dynar:
3988 @idx:
3989 @object:
3990 @Returns:
3991
3992 <!-- ##### FUNCTION gras_dynar_remplace ##### -->
3993 <para>
3994
3995 </para>
3996
3997 @dynar:
3998 @idx:
3999 @object:
4000 @Returns:
4001
4002 <!-- ##### FUNCTION gras_dynar_reset ##### -->
4003 <para>
4004
4005 </para>
4006
4007 @dynar:
4008 @Returns:
4009
4010 <!-- ##### FUNCTION gras_dynar_set ##### -->
4011 <para>
4012
4013 </para>
4014
4015 @dynar:
4016 @idx:
4017 @src:
4018 @Returns:
4019 @object:
4020
4021 <!-- ##### FUNCTION gras_dynar_shift ##### -->
4022 <para>
4023
4024 </para>
4025
4026 @dynar:
4027 @dst:
4028 @whereto:
4029 @Returns:
4030
4031 <!-- ##### FUNCTION gras_dynar_unshift ##### -->
4032 <para>
4033
4034 </para>
4035
4036 @dynar:
4037 @src:
4038 @Returns:
4039 @object:
4040
4041 <!-- ##### ENUM gras_error_t ##### -->
4042 <para>
4043
4044 </para>
4045
4046 @no_error: no error
4047 @mismatch_error: Not found
4048 @system_error: a syscall did fail
4049 @network_error: error while sending/receiving data
4050 @timeout_error: not quick enough, dude
4051 @thread_error: error while [un]locking
4052 @unknown_error: no idea
4053
4054 <!-- ##### FUNCTION gras_lock ##### -->
4055 <para>
4056
4057 </para>
4058
4059 @Returns:
4060
4061 <!-- ##### FUNCTION gras_log_appender_set ##### -->
4062 <para>
4063
4064 </para>
4065
4066 @cat:
4067 @app:
4068
4069 <!-- ##### FUNCTION gras_log_control_set ##### -->
4070 <para>
4071
4072 </para>
4073
4074 @cs:
4075 @Returns:
4076
4077 <!-- ##### VARIABLE gras_log_default_appender ##### -->
4078 <para>
4079
4080 </para>
4081
4082
4083 <!-- ##### FUNCTION gras_log_parent_set ##### -->
4084 <para>
4085
4086 </para>
4087
4088 @cat:
4089 @parent:
4090
4091 <!-- ##### ENUM gras_log_priority_t ##### -->
4092 <para>
4093
4094 </para>
4095
4096 @gras_log_priority_none:
4097 @gras_log_priority_trace:
4098 @gras_log_priority_debug:
4099 @gras_log_priority_verbose:
4100 @gras_log_priority_info:
4101 @gras_log_priority_warning:
4102 @gras_log_priority_error:
4103 @gras_log_priority_critical:
4104 @gras_log_priority_infinite:
4105 @gras_log_priority_uninitialized:
4106
4107 <!-- ##### FUNCTION gras_log_threshold_set ##### -->
4108 <para>
4109
4110 </para>
4111
4112 @cat:
4113 @thresholdPriority:
4114
4115 <!-- ##### FUNCTION gras_msg_discard ##### -->
4116 <para>
4117
4118 </para>
4119
4120 @sd:
4121 @size:
4122
4123 <!-- ##### FUNCTION gras_msg_free ##### -->
4124 <para>
4125
4126 </para>
4127
4128 @msg:
4129
4130 <!-- ##### FUNCTION gras_msg_new ##### -->
4131 <para>
4132
4133 </para>
4134
4135 @msgId:
4136 @free_data_on_free:
4137 @seqCount:
4138 @Varargs:
4139 @Returns:
4140
4141 <!-- ##### FUNCTION gras_msgtype_register ##### -->
4142 <para>
4143
4144 </para>
4145
4146 @msgId:
4147 @name:
4148 @sequence_count:
4149 @Varargs:
4150 @Returns:
4151
4152 <!-- ##### FUNCTION gras_set_add ##### -->
4153 <para>
4154
4155 </para>
4156
4157 @set:
4158 @elm:
4159 @free_func:
4160 @Returns:
4161
4162 <!-- ##### MACRO gras_set_foreach ##### -->
4163 <para>
4164
4165 </para>
4166
4167 @set:
4168 @cursor:
4169 @elm:
4170
4171 <!-- ##### FUNCTION gras_set_free ##### -->
4172 <para>
4173
4174 </para>
4175
4176 @set:
4177
4178 <!-- ##### FUNCTION gras_set_get_by_id ##### -->
4179 <para>
4180
4181 </para>
4182
4183 @set:
4184 @id:
4185 @dst:
4186 @Returns:
4187
4188 <!-- ##### FUNCTION gras_set_get_by_name ##### -->
4189 <para>
4190
4191 </para>
4192
4193 @set:
4194 @key:
4195 @dst:
4196 @Returns:
4197
4198 <!-- ##### FUNCTION gras_set_get_by_name_ext ##### -->
4199 <para>
4200
4201 </para>
4202
4203 @set:
4204 @name:
4205 @name_len:
4206 @dst:
4207 @Returns:
4208
4209 <!-- ##### FUNCTION gras_set_new ##### -->
4210 <para>
4211
4212 </para>
4213
4214 @Returns:
4215 @dst:
4216
4217 <!-- ##### FUNCTION gras_sleep ##### -->
4218 <para>
4219
4220 </para>
4221
4222 @Param1:
4223 @Param2:
4224
4225 <!-- ##### FUNCTION gras_sock_client_open ##### -->
4226 <para>
4227
4228 </para>
4229
4230 @host:
4231 @Param2:
4232 @sock:
4233 @Returns:
4234
4235 <!-- ##### FUNCTION gras_sock_close ##### -->
4236 <para>
4237
4238 </para>
4239
4240 @sock:
4241 @Returns:
4242
4243 <!-- ##### FUNCTION gras_sock_get_peer_addr ##### -->
4244 <para>
4245
4246 </para>
4247
4248 @sd:
4249 @Returns:
4250
4251 <!-- ##### FUNCTION gras_sock_get_peer_name ##### -->
4252 <para>
4253
4254 </para>
4255
4256 @sd:
4257 @Returns:
4258
4259 <!-- ##### FUNCTION gras_sock_server_open ##### -->
4260 <para>
4261
4262 </para>
4263
4264 @Param1:
4265 @Param2:
4266 @sock:
4267 @Returns:
4268
4269 <!-- ##### FUNCTION gras_time ##### -->
4270 <para>
4271
4272 </para>
4273
4274 @Returns:
4275
4276 <!-- ##### FUNCTION gras_unlock ##### -->
4277 <para>
4278
4279 </para>
4280
4281 @Returns:
4282