debian/libwvstreams-dev/usr/include/wvstreams/uniclientconn.h

/* -*- Mode: C++ -*-
 * Worldvisions Tunnel Vision Software:
 *   Copyright (C) 1997-2002 Net Integration Technologies, Inc.
 *
 * Manages a connection between the UniConf client and daemon.
 */
#ifndef __UNICONFCONN_H
#define __UNICONFCONN_H
 
#include "uniconfkey.h"
#include "uniconfgen.h"
#include "wvstreamclone.h"
#include "wvistreamlist.h"
#include "wvbuf.h"
#include "wvlog.h"
 
#define UNICONF_PROTOCOL_VERSION UniClientConn::NUM_COMMANDS
#define DEFAULT_UNICONF_DAEMON_TCP_PORT 4111
#define DEFAULT_UNICONF_DAEMON_SSL_PORT 4112

class UniClientConn : public WvStreamClone
{
    WvDynBuf msgbuf;
 
protected:
    WvLog log;
    bool closed;
    int version;
    
public:
    WvConstStringBuffer payloadbuf; 
 
    /* This table is _very_ important!!!
     *
     * With UniConf, we promise to never remove or modify the behaviour of
     * any of the commands listed here.  If you want to modify anything,
     * you'd better just add a new command instead.  We keep track of the
     * version of the UniConf protocol by the number of commands supported
     * by the server.
     *
     * @see UniClientConn::cmdinfos
     */
    enum Command
    {
        NONE = -2, 
        INVALID = -1, 
 
        // requests
        REQ_NOOP, 
        REQ_GET, 
        REQ_SET, 
        REQ_SETV, 
        REQ_REMOVE, 
        REQ_SUBTREE, 
        REQ_HASCHILDREN, 
        REQ_COMMIT, 
        REQ_REFRESH, 
        REQ_QUIT, 
        REQ_HELP, 
 
        // command completion replies
        REPLY_OK, 
        REPLY_FAIL, 
        REPLY_CHILD, 
        REPLY_ONEVAL, 
 
        // partial replies
        PART_VALUE, 
        PART_TEXT, 
 
        // events
        EVENT_HELLO, 
        EVENT_NOTICE, 
    };
    static const int NUM_COMMANDS = EVENT_NOTICE + 1;
    struct CommandInfo
    {
        const char *name;
        const char *description;
    };
    static const CommandInfo cmdinfos[NUM_COMMANDS];

    UniClientConn(IWvStream *_s, WvStringParm dst = WvString::null);
    virtual ~UniClientConn();
 
    virtual void close();

    Command readcmd();
    Command readcmd(WvString &command);

    WvString readarg();

    void writecmd(Command command, WvStringParm payload = WvString::null);

    void writeok(WvStringParm payload = "");

    void writefail(WvStringParm payload = "");

    void writevalue(const UniConfKey &key, WvStringParm value);
 
    void writeonevalue(const UniConfKey &key, WvStringParm value);

    void writetext(WvStringParm text);
 
private:
    WvString readmsg();

    void writemsg(WvStringParm message);
};
 
#endif // __UNICONFCONN_H