ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/kgsueme/doc/protocol.html
(Generate patch)

Comparing kgsueme/doc/protocol.html (file contents):
Revision 1.33 by pcg, Tue Jul 22 02:36:17 2003 UTC vs.
Revision 1.34 by pcg, Tue Jul 22 13:12:38 2003 UTC

19 Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 19 Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20--> 20-->
21</head> 21</head>
22<body> 22<body>
23 23
24<h1>$Revision: 1.33 $</h1> 24<h1>$Revision: 1.34 $</h1>
25 25
26<h1>KGS Protocol Description</h1> 26<h1>KGS Protocol Description</h1>
27 27
28 <p>This XML document describes the KGS protocol. It is also used 28 <p>This XML document describes the KGS protocol. It is also used
29 to automatically generate the perl parser for all the messages and 29 to automatically generate the perl parser for all the messages and
2787 <b></b> 2787 <b></b>
2788   2788  
2789 </td> 2789 </td>
2790 </tr> 2790 </tr>
2791 <tr> 2791 <tr>
2792 <td>flags</td> 2792 <td>type</td>
2793 <td>U8</td> 2793 <td>U8</td>
2794 <td> </td> 2794 <td> </td>
2795 <td> 2795 <td>
2796 High four bits are handicap, low four bits are gametype (encoded strangely? unclear). 2796 High four bits are handicap, low four bits are gametype (encoded strangely? unclear).
2797 2797
2833 <tr> 2833 <tr>
2834 <td>user3</td> 2834 <td>user3</td>
2835 <td>user</td> 2835 <td>user</td>
2836 <td> </td> 2836 <td> </td>
2837 <td> 2837 <td>
2838 Owner (or empty) 2838
2839 2839
2840   2840  
2841 </td> 2841 </td>
2842 <td> 2842 <td>
2843 <b></b> 2843 <b></b>
2873 <tr> 2873 <tr>
2874 <td>status</td> 2874 <td>status</td>
2875 <td>U8</td> 2875 <td>U8</td>
2876 <td> </td> 2876 <td> </td>
2877 <td> 2877 <td>
2878 0x80 inprogress 2878
2879 2879
2880   2880  
2881 </td> 2881 </td>
2882 <td> 2882 <td>
2883 <b></b> 2883 <b></b>
2884   2884  
3244 </td> 3244 </td>
3245 <td> 3245 <td>
3246 <b></b> 3246 <b></b>
3247   3247  
3248 </td> 3248 </td>
3249 </tr>
3250 </table>
3251
3252 <h4>
3253 <a name="S0013"></a>ORIGIN: SERVER;
3254 MESSAGE: msg_chat</h4>
3255 NUMERIC TYPE (hex): 0013<p>
3256 </p>
3257 <table border="1" width="100%">
3258 <tr>
3259 <th width="10%">NAME</th>
3260 <th width="10%">TYPE</th>
3261 <th width="15%">DEFAULT</th>
3262 <th>DESCRIPTION</th>
3263 <th width="15%">DEC-GUARD</th>
3264 </tr>
3265 <tr>
3266 <td>name</td>
3267 <td>username</td>
3268 <td> </td>
3269 <td>
3270
3271  
3272 </td>
3273 <td>
3274 <b></b>
3275  
3276 </td>
3277 </tr>
3278 <tr>
3279 <td>name2</td>
3280 <td>username</td>
3281 <td> </td>
3282 <td>
3283
3284  
3285 </td>
3286 <td>
3287 <b></b>
3288  
3289 </td>
3290 </tr>
3291 <tr>
3292 <td>message</td>
3293 <td>STRING</td>
3294 <td> </td>
3295 <td>
3296
3297  
3298 </td>
3299 <td>
3300 <b></b>
3301  
3302 </td>
3303 </tr>
3304 </table>
3305
3306 <h4>
3307 <a name="S0015"></a>ORIGIN: SERVER;
3308 MESSAGE: stats</h4>
3309 NUMERIC TYPE (hex): 0015
3310 (possibly in response to
3311 <a href="#C0014">req_stats(0014)</a>
3312 )
3313 <p>
3314 </p>
3315 <table border="1" width="100%">
3316 <tr>
3317 <th width="10%">NAME</th>
3318 <th width="10%">TYPE</th>
3319 <th width="15%">DEFAULT</th>
3320 <th>DESCRIPTION</th>
3321 <th width="15%">DEC-GUARD</th>
3322 </tr>
3323 <tr>
3324 <td>ver_major</td>
3325 <td>U16</td>
3326 <td> </td>
3327 <td>
3328
3329  
3330 </td>
3331 <td>
3332 <b></b>
3333  
3334 </td>
3335 </tr>
3336 <tr>
3337 <td>ver_minor</td>
3338 <td>U16</td>
3339 <td> </td>
3340 <td>
3341
3342  
3343 </td>
3344 <td>
3345 <b></b>
3346  
3347 </td>
3348 </tr>
3349 <tr>
3350 <td>ver_micro</td>
3351 <td>U16</td>
3352 <td> </td>
3353 <td>
3354
3355  
3356 </td>
3357 <td>
3358 <b></b>
3359  
3360 </td>
3361 </tr>
3362 <tr>
3363 <td>boot_time</td>
3364 <td>timestamp</td>
3365 <td> </td>
3366 <td>
3367
3368  
3369 </td>
3370 <td>
3371 <b></b>
3372  
3373 </td>
3374 </tr>
3375 <tr>
3376 <td>users_cur</td>
3377 <td>U32</td>
3378 <td> </td>
3379 <td>
3380
3381  
3382 </td>
3383 <td>
3384 <b></b>
3385  
3386 </td>
3387 </tr>
3388 <tr>
3389 <td>users_max</td>
3390 <td>U32</td>
3391 <td> </td>
3392 <td>
3393
3394  
3395 </td>
3396 <td>
3397 <b></b>
3398  
3399 </td>
3400 </tr>
3401 <tr>
3402 <td>users_lim</td>
3403 <td>U32</td>
3404 <td> </td>
3405 <td>
3406
3407  
3408 </td>
3409 <td>
3410 <b></b>
3411  
3412 </td>
3413 </tr>
3414 <tr>
3415 <td>accts_cur</td>
3416 <td>U32</td>
3417 <td> </td>
3418 <td>
3419
3420  
3421 </td>
3422 <td>
3423 <b></b>
3424  
3425 </td>
3426 </tr>
3427 <tr>
3428 <td>accts_max</td>
3429 <td>U32</td>
3430 <td> </td>
3431 <td>
3432
3433  
3434 </td>
3435 <td>
3436 <b></b>
3437  
3438 </td>
3439 </tr>
3440 <tr>
3441 <td>unknown1</td>
3442 <td>U32</td>
3443 <td> </td>
3444 <td>
3445
3446  
3447 </td>
3448 <td>
3449 <b></b>
3450  
3451 </td>
3452 </tr>
3453 <tr>
3454 <td>work_max</td>
3455 <td>U32</td>
3456 <td> </td>
3457 <td>
3458
3459  
3460 </td>
3461 <td>
3462 <b></b>
3463  
3464 </td>
3465 </tr>
3466 <tr>
3467 <td>rooms_cur</td>
3468 <td>U32</td>
3469 <td> </td>
3470 <td>
3471
3472  
3473 </td>
3474 <td>
3475 <b></b>
3476  
3477 </td>
3478 </tr>
3479 <tr>
3480 <td>rooms_max</td>
3481 <td>U32</td>
3482 <td> </td>
3483 <td>
3484
3485  
3486 </td>
3487 <td>
3488 <b></b>
3489  
3490 </td>
3491 </tr>
3492 <tr>
3493 <td>rooms_lim</td>
3494 <td>U32</td>
3495 <td> </td>
3496 <td>
3497
3498  
3499 </td>
3500 <td>
3501 <b></b>
3502  
3503 </td>
3504 </tr>
3505 <tr>
3506 <td>games_cur</td>
3507 <td>U32</td>
3508 <td> </td>
3509 <td>
3510
3511  
3512 </td>
3513 <td>
3514 <b></b>
3515  
3516 </td>
3517 </tr>
3518 <tr>
3519 <td>games_max</td>
3520 <td>U32</td>
3521 <td> </td>
3522 <td>
3523
3524  
3525 </td>
3526 <td>
3527 <b></b>
3528  
3529 </td>
3530 </tr>
3531 <tr>
3532 <td>games_lim</td>
3533 <td>U32</td>
3534 <td> </td>
3535 <td>
3536
3537  
3538 </td>
3539 <td>
3540 <b></b>
3541  
3542 </td>
3543 </tr>
3544 <tr>
3545 <td>results_cur</td>
3546 <td>U32</td>
3547 <td> </td>
3548 <td>
3549
3550  
3551 </td>
3552 <td>
3553 <b></b>
3554  
3555 </td>
3556 </tr>
3557 <tr>
3558 <td>results_max</td>
3559 <td>U32</td>
3560 <td> </td>
3561 <td>
3562
3563  
3564 </td>
3565 <td>
3566 <b></b>
3567  
3568 </td>
3569 </tr>
3570 <tr>
3571 <td>unknown2</td>
3572 <td>U32</td>
3573 <td> </td>
3574 <td>
3575
3576  
3577 </td>
3578 <td>
3579 <b></b>
3580  
3581 </td>
3582 </tr>
3583 <tr>
3584 <td>params_cur</td>
3585 <td>U32</td>
3586 <td> </td>
3587 <td>
3588
3589  
3590 </td>
3591 <td>
3592 <b></b>
3593  
3594 </td>
3595 </tr>
3596 <tr>
3597 <td>params_max</td>
3598 <td>U32</td>
3599 <td> </td>
3600 <td>
3601
3602  
3603 </td>
3604 <td>
3605 <b></b>
3606  
3607 </td>
3608 </tr>
3609 <tr>
3610 <td>bytes_in</td>
3611 <td>U64</td>
3612 <td> </td>
3613 <td>
3614
3615  
3616 </td>
3617 <td>
3618 <b></b>
3619  
3620 </td>
3621 </tr>
3622 <tr>
3623 <td>packets_in</td>
3624 <td>U64</td>
3625 <td> </td>
3626 <td>
3627
3628  
3629 </td>
3630 <td>
3631 <b></b>
3632  
3633 </td>
3634 </tr>
3635 <tr>
3636 <td>bytes_out</td>
3637 <td>U64</td>
3638 <td> </td>
3639 <td>
3640
3641  
3642 </td>
3643 <td>
3644 <b></b>
3645  
3646 </td>
3647 </tr>
3648 <tr>
3649 <td>packets_out</td>
3650 <td>U64</td>
3651 <td> </td>
3652 <td>
3653
3654  
3655 </td>
3656 <td>
3657 <b></b>
3658  
3659 </td>
3660 </tr>
3661 </table>
3662
3663 <h4>
3664 <a name="S0016"></a>ORIGIN: SERVER;
3665 MESSAGE: idle_warn</h4>
3666 NUMERIC TYPE (hex): 0016
3667 (possibly in response to
3668 <a href="#C0016">idle_reset(0016)</a>
3669 )
3670 <p>
3671 idle warning, autologout soon (10 minutes...)
3672 </p>
3673 <table border="1" width="100%">
3674 <tr>
3675 <th width="10%">NAME</th>
3676 <th width="10%">TYPE</th>
3677 <th width="15%">DEFAULT</th>
3678 <th>DESCRIPTION</th>
3679 <th width="15%">DEC-GUARD</th>
3249 </tr> 3680 </tr>
3250 </table> 3681 </table>
3251 3682
3252 <h4> 3683 <h4>
3253 <a name="S0018"></a>ORIGIN: SERVER; 3684 <a name="S0018"></a>ORIGIN: SERVER;
3329 </td> 3760 </td>
3330 </tr> 3761 </tr>
3331 </table> 3762 </table>
3332 3763
3333 <h4> 3764 <h4>
3334 <a name="S0013"></a>ORIGIN: SERVER;
3335 MESSAGE: msg_chat</h4>
3336 NUMERIC TYPE (hex): 0013<p>
3337 </p>
3338 <table border="1" width="100%">
3339 <tr>
3340 <th width="10%">NAME</th>
3341 <th width="10%">TYPE</th>
3342 <th width="15%">DEFAULT</th>
3343 <th>DESCRIPTION</th>
3344 <th width="15%">DEC-GUARD</th>
3345 </tr>
3346 <tr>
3347 <td>user1</td>
3348 <td>username</td>
3349 <td> </td>
3350 <td>
3351
3352  
3353 </td>
3354 <td>
3355 <b></b>
3356  
3357 </td>
3358 </tr>
3359 <tr>
3360 <td>user2</td>
3361 <td>username</td>
3362 <td> </td>
3363 <td>
3364
3365  
3366 </td>
3367 <td>
3368 <b></b>
3369  
3370 </td>
3371 </tr>
3372 <tr>
3373 <td>message</td>
3374 <td>STRING</td>
3375 <td> </td>
3376 <td>
3377
3378  
3379 </td>
3380 <td>
3381 <b></b>
3382  
3383 </td>
3384 </tr>
3385 </table>
3386
3387 <h4>
3388 <a name="S0015"></a>ORIGIN: SERVER;
3389 MESSAGE: stats</h4>
3390 NUMERIC TYPE (hex): 0015
3391 (possibly in response to
3392 <a href="#C0014">req_stats(0014)</a>
3393 )
3394 <p>
3395 </p>
3396 <table border="1" width="100%">
3397 <tr>
3398 <th width="10%">NAME</th>
3399 <th width="10%">TYPE</th>
3400 <th width="15%">DEFAULT</th>
3401 <th>DESCRIPTION</th>
3402 <th width="15%">DEC-GUARD</th>
3403 </tr>
3404 <tr>
3405 <td>ver_major</td>
3406 <td>U16</td>
3407 <td> </td>
3408 <td>
3409
3410  
3411 </td>
3412 <td>
3413 <b></b>
3414  
3415 </td>
3416 </tr>
3417 <tr>
3418 <td>ver_minor</td>
3419 <td>U16</td>
3420 <td> </td>
3421 <td>
3422
3423  
3424 </td>
3425 <td>
3426 <b></b>
3427  
3428 </td>
3429 </tr>
3430 <tr>
3431 <td>ver_micro</td>
3432 <td>U16</td>
3433 <td> </td>
3434 <td>
3435
3436  
3437 </td>
3438 <td>
3439 <b></b>
3440  
3441 </td>
3442 </tr>
3443 <tr>
3444 <td>boot_time</td>
3445 <td>timestamp</td>
3446 <td> </td>
3447 <td>
3448
3449  
3450 </td>
3451 <td>
3452 <b></b>
3453  
3454 </td>
3455 </tr>
3456 <tr>
3457 <td>users_cur</td>
3458 <td>U32</td>
3459 <td> </td>
3460 <td>
3461
3462  
3463 </td>
3464 <td>
3465 <b></b>
3466  
3467 </td>
3468 </tr>
3469 <tr>
3470 <td>users_max</td>
3471 <td>U32</td>
3472 <td> </td>
3473 <td>
3474
3475  
3476 </td>
3477 <td>
3478 <b></b>
3479  
3480 </td>
3481 </tr>
3482 <tr>
3483 <td>users_lim</td>
3484 <td>U32</td>
3485 <td> </td>
3486 <td>
3487
3488  
3489 </td>
3490 <td>
3491 <b></b>
3492  
3493 </td>
3494 </tr>
3495 <tr>
3496 <td>accts_cur</td>
3497 <td>U32</td>
3498 <td> </td>
3499 <td>
3500
3501  
3502 </td>
3503 <td>
3504 <b></b>
3505  
3506 </td>
3507 </tr>
3508 <tr>
3509 <td>accts_max</td>
3510 <td>U32</td>
3511 <td> </td>
3512 <td>
3513
3514  
3515 </td>
3516 <td>
3517 <b></b>
3518  
3519 </td>
3520 </tr>
3521 <tr>
3522 <td>unknown1</td>
3523 <td>U32</td>
3524 <td> </td>
3525 <td>
3526
3527  
3528 </td>
3529 <td>
3530 <b></b>
3531  
3532 </td>
3533 </tr>
3534 <tr>
3535 <td>work_max</td>
3536 <td>U32</td>
3537 <td> </td>
3538 <td>
3539
3540  
3541 </td>
3542 <td>
3543 <b></b>
3544  
3545 </td>
3546 </tr>
3547 <tr>
3548 <td>rooms_cur</td>
3549 <td>U32</td>
3550 <td> </td>
3551 <td>
3552
3553  
3554 </td>
3555 <td>
3556 <b></b>
3557  
3558 </td>
3559 </tr>
3560 <tr>
3561 <td>rooms_max</td>
3562 <td>U32</td>
3563 <td> </td>
3564 <td>
3565
3566  
3567 </td>
3568 <td>
3569 <b></b>
3570  
3571 </td>
3572 </tr>
3573 <tr>
3574 <td>rooms_lim</td>
3575 <td>U32</td>
3576 <td> </td>
3577 <td>
3578
3579  
3580 </td>
3581 <td>
3582 <b></b>
3583  
3584 </td>
3585 </tr>
3586 <tr>
3587 <td>games_cur</td>
3588 <td>U32</td>
3589 <td> </td>
3590 <td>
3591
3592  
3593 </td>
3594 <td>
3595 <b></b>
3596  
3597 </td>
3598 </tr>
3599 <tr>
3600 <td>games_max</td>
3601 <td>U32</td>
3602 <td> </td>
3603 <td>
3604
3605  
3606 </td>
3607 <td>
3608 <b></b>
3609  
3610 </td>
3611 </tr>
3612 <tr>
3613 <td>games_lim</td>
3614 <td>U32</td>
3615 <td> </td>
3616 <td>
3617
3618  
3619 </td>
3620 <td>
3621 <b></b>
3622  
3623 </td>
3624 </tr>
3625 <tr>
3626 <td>results_cur</td>
3627 <td>U32</td>
3628 <td> </td>
3629 <td>
3630
3631  
3632 </td>
3633 <td>
3634 <b></b>
3635  
3636 </td>
3637 </tr>
3638 <tr>
3639 <td>results_max</td>
3640 <td>U32</td>
3641 <td> </td>
3642 <td>
3643
3644  
3645 </td>
3646 <td>
3647 <b></b>
3648  
3649 </td>
3650 </tr>
3651 <tr>
3652 <td>unknown2</td>
3653 <td>U32</td>
3654 <td> </td>
3655 <td>
3656
3657  
3658 </td>
3659 <td>
3660 <b></b>
3661  
3662 </td>
3663 </tr>
3664 <tr>
3665 <td>params_cur</td>
3666 <td>U32</td>
3667 <td> </td>
3668 <td>
3669
3670  
3671 </td>
3672 <td>
3673 <b></b>
3674  
3675 </td>
3676 </tr>
3677 <tr>
3678 <td>params_max</td>
3679 <td>U32</td>
3680 <td> </td>
3681 <td>
3682
3683  
3684 </td>
3685 <td>
3686 <b></b>
3687  
3688 </td>
3689 </tr>
3690 <tr>
3691 <td>bytes_in</td>
3692 <td>U64</td>
3693 <td> </td>
3694 <td>
3695
3696  
3697 </td>
3698 <td>
3699 <b></b>
3700  
3701 </td>
3702 </tr>
3703 <tr>
3704 <td>packets_in</td>
3705 <td>U64</td>
3706 <td> </td>
3707 <td>
3708
3709  
3710 </td>
3711 <td>
3712 <b></b>
3713  
3714 </td>
3715 </tr>
3716 <tr>
3717 <td>bytes_out</td>
3718 <td>U64</td>
3719 <td> </td>
3720 <td>
3721
3722  
3723 </td>
3724 <td>
3725 <b></b>
3726  
3727 </td>
3728 </tr>
3729 <tr>
3730 <td>packets_out</td>
3731 <td>U64</td>
3732 <td> </td>
3733 <td>
3734
3735  
3736 </td>
3737 <td>
3738 <b></b>
3739  
3740 </td>
3741 </tr>
3742 </table>
3743
3744 <h4>
3745 <a name="S0016"></a>ORIGIN: SERVER;
3746 MESSAGE: idle_warn</h4>
3747 NUMERIC TYPE (hex): 0016
3748 (possibly in response to
3749 <a href="#C0016">idle_reset(0016)</a>
3750 )
3751 <p>
3752 idle warning, autologout soon (10 minutes...)
3753 </p>
3754 <table border="1" width="100%">
3755 <tr>
3756 <th width="10%">NAME</th>
3757 <th width="10%">TYPE</th>
3758 <th width="15%">DEFAULT</th>
3759 <th>DESCRIPTION</th>
3760 <th width="15%">DEC-GUARD</th>
3761 </tr>
3762 </table>
3763
3764 <h4>
3765 <a name="S001b"></a>ORIGIN: SERVER; 3765 <a name="S001b"></a>ORIGIN: SERVER;
3766 MESSAGE: timewarning_default</h4> 3766 MESSAGE: timewarning_default</h4>
3767 NUMERIC TYPE (hex): 001b 3767 NUMERIC TYPE (hex): 001b
3768 (possibly in response to 3768 (possibly in response to
3769 <a href="#C0000">login(0000)</a> 3769 <a href="#C0000">login(0000)</a>
4107 <b></b> 4107 <b></b>
4108   4108  
4109 </td> 4109 </td>
4110 </tr> 4110 </tr>
4111 <tr> 4111 <tr>
4112 <td>lotsofinfo</td> 4112 <td>gamerecord</td>
4113 <td>game_record</td> 4113 <td>game_record</td>
4114 <td> </td> 4114 <td> </td>
4115 <td> 4115 <td>
4116 4116
4117   4117  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines