UniClientConn Class Reference

#include <uniclientconn.h>

Inheritance diagram for UniClientConn:
[legend]

List of all members.


Detailed Description

Represents a connection to a UniConf daemon via any WvStream.

Makes several operations much simpler, such as TCL encoding/decoding of lists, filling of the operation buffer and comparison for UniConf operations.

Definition at line 27 of file uniclientconn.h.


Public Types

enum  Command {
  NONE = -2, INVALID = -1, REQ_NOOP, REQ_GET,
  REQ_SET, REQ_SETV, REQ_REMOVE, REQ_SUBTREE,
  REQ_HASCHILDREN, REQ_COMMIT, REQ_REFRESH, REQ_QUIT,
  REQ_HELP, REPLY_OK, REPLY_FAIL, REPLY_CHILD,
  REPLY_ONEVAL, PART_VALUE, PART_TEXT, EVENT_HELLO,
  EVENT_NOTICE
}

Public Member Functions

 UniClientConn (IWvStream *_s, WvStringParm dst=WvString::null)
 Create a wrapper around the supplied WvStream.
virtual void close ()
 Close the stream if it is open; isok() becomes false from now on.
Command readcmd ()
 Reads a command from the connection.
Command readcmd (WvString &command)
WvString readarg ()
 Reads the next argument from the command payload.
void writecmd (Command command, WvStringParm payload=WvString::null)
 Writes a command to the connection.
void writeok (WvStringParm payload="")
 Writes a REPLY_OK message.
void writefail (WvStringParm payload="")
 Writes a REPLY_FAIL message.
void writevalue (const UniConfKey &key, WvStringParm value)
 Writes a PART_VALUE message.
void writeonevalue (const UniConfKey &key, WvStringParm value)
 Writes a PART_VALUE message.
void writetext (WvStringParm text)
 Writes a PART_TEXT message.
virtual void setclone (IWvStream *clone)
virtual bool flush_internal (time_t msec_timeout)
virtual size_t uread (void *buf, size_t size)
 unbuffered I/O functions; these ignore the buffer, which is handled by read().
virtual size_t uwrite (const void *buf, size_t size)
 unbuffered I/O functions; these ignore the buffer, which is handled by write().
virtual bool isok () const
 return true if the stream is actually usable right now
virtual int geterr () const
 If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.
virtual WvString errstr () const
virtual void pre_select (SelectInfo &si)
 pre_select() sets up for eventually calling select().
void pre_select (SelectInfo &si, const SelectRequest &r)
 A more convenient version of pre_select() usable for overriding the 'want' value temporarily.
virtual bool post_select (SelectInfo &si)
 post_select() is called after select(), and returns true if this object is now ready.
bool post_select (SelectInfo &si, const SelectRequest &r)
 A more convenient version of post_select() usable for overriding the 'want' value temporarily.
virtual const WvAddrsrc () const
 get the remote address from which the last data block was received.
virtual void execute ()
 The callback() function calls execute(), and then calls the user- specified callback if one is defined.
virtual void noread ()
virtual void nowrite ()
const char * wstype () const
virtual void seterr (int _errnum)
 Override seterr() from WvError so that it auto-closes the stream.
void seterr (WvStringParm specialerr)
void seterr (WVSTRING_FORMAT_DECL)
void seterr (const WvErrorBase &err)
virtual size_t read (void *buf, size_t count)
 read a data block on the stream.
virtual size_t read (WvBuf &outbuf, size_t count)
 Reads up to 'count' bytes of data from the stream into the buffer.
virtual void unread (WvBuf &outbuf, size_t count)
 Puts data back into the stream's internal buffer.
virtual size_t write (const void *buf, size_t count)
 Write data to the stream.
virtual size_t write (WvBuf &inbuf, size_t count=INT_MAX)
 Writes data to the stream from the given buffer.
size_t write (WvStringParm s)
 print a preformatted WvString to the stream.
void outbuf_limit (size_t size)
 set the maximum size of outbuf, beyond which a call to write() will return 0.
virtual void maybe_autoclose ()
virtual bool isreadable ()
virtual bool iswritable ()
char * getline (time_t wait_msec=0, char separator= '\n', int readahead=1024)
 Read up to one line of data from the stream and return a pointer to the internal buffer containing this line.
char * getline (int wait_msec, char separator= '\n', int readahead=1024)
 Auto-convert int to time_t.
char * getline (double wait_msec, char separator= '\n', int readahead=1024)
 Auto-convert double to time_t.
char * blocking_getline (time_t wait_msec, int separator= '\n', int readahead=1024)
 This is a version of getline() that allows you to block for more data to arrive.
char * continue_getline (time_t wait_msec, int separator= '\n', int readahead=1024)
 This is a version of blocking_getline() that uses continue_select to avoid blocking other streams.
void queuemin (size_t count)
 force read() to not return any bytes unless 'count' bytes can be read at once.
void drain ()
 drain the input buffer (read and discard data until select(0) returns false)
void delay_output (bool is_delayed)
 force write() to always buffer output.
void auto_flush (bool is_automatic)
 if true, force write() to call flush() each time, the default behavour.
virtual bool flush (time_t msec_timeout)
 flush the output buffer, if we can do it without delaying more than msec_timeout milliseconds at a time.
virtual bool should_flush ()
void flush_then_close (int msec_timeout)
 flush the output buffer automatically as select() is called.
void xpre_select (SelectInfo &si, const SelectRequest &r)
 Like pre_select(), but still exists even if you override the other pre_select() in a subclass.
bool xpost_select (SelectInfo &si, const SelectRequest &r)
 Like post_select(), but still exists even if you override the other post_select() in a subclass.
bool select (time_t msec_timeout)
 Return true if any of the requested features are true on the stream.
bool select (time_t msec_timeout, bool readable, bool writable, bool isex=false)
 This version of select() sets forceable==false, so we use the exact readable/writable/isexception options provided.
void runonce (time_t msec_timeout=-1)
 Exactly the same as: if (select(timeout)) callback();.
IWvStream::SelectRequest get_select_request ()
 Use get_select_request() to save the current state of the selection state of this stream.
void force_select (bool readable, bool writable, bool isexception=false)
 Use force_select() to force one or more particular modes (readable, writable, or isexception) to true when selecting on this stream.
void undo_force_select (bool readable, bool writable, bool isexception=false)
 Undo a previous force_select() - ie.
bool continue_select (time_t msec_timeout)
 return to the caller from execute(), but don't really return exactly; this uses WvCont::yield() to return to the caller of callback() without losing our place in execute() itself.
void terminate_continue_select ()
 you MUST run this from your destructor if you use continue_select(), or very weird things will happen if someone deletes your object while in continue_select().
void setcallback (WvStreamCallback _callfunc, void *_userdata)
 define the callback function for this stream, called whenever the callback() member is run, and passed the 'userdata' pointer.
IWvStreamCallback setreadcallback (IWvStreamCallback _callback)
 Sets a callback to be invoked when the stream is readable.
IWvStreamCallback setwritecallback (IWvStreamCallback _callback)
 Sets a callback to be invoked when the stream is writable.
IWvStreamCallback setexceptcallback (IWvStreamCallback _callback)
 Sets a callback to be invoked when the stream is in exception state.
IWvStreamCallback setclosecallback (IWvStreamCallback _callback)
 Sets a callback to be invoked on close().
void autoforward (WvStream &s)
 set the callback function for this stream to an internal routine that auto-forwards all incoming stream data to the given output stream.
void noautoforward ()
 Stops autoforwarding.
void * _callwrap (void *)
 A wrapper that's compatible with WvCont, but calls the "real" callback.
void _callback ()
 Actually call the registered callfunc and execute().
virtual void callback ()
 if the stream has a callback function defined, call it now.
void alarm (time_t msec_timeout)
 set an alarm, ie.
time_t alarm_remaining ()
 return the number of milliseconds remaining before the alarm will go off; -1 means no alarm is set (infinity), 0 means the alarm has been hit and will be cleared by the next callback().
size_t print (WvStringParm s)
size_t print (WVSTRING_FORMAT_DECL)
 preformat and write() a string.
size_t operator() (WvStringParm s)
size_t operator() (WVSTRING_FORMAT_DECL)
const char * wsname () const
void set_wsname (WvStringParm wsname)
void set_wsname (WVSTRING_FORMAT_DECL)
WSID wsid () const
void seterr_both (int _errnum, WvStringParm specialerr)
void noerr ()
 Reset our error state - there's no error condition anymore.
virtual unsigned int addRef ()=0
 Indicate you are using this object.
virtual unsigned int release ()=0
 Indicate that you are finished using this object.
virtual IObjectgetInterface (const UUID &)=0
 Returns the requested XPLC interface.
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.

Static Public Member Functions

static void autoforward_callback (WvStream &s, void *userdata)
static IWvStream * find_by_wsid (WSID wsid)
static WvString strerror (int errnum)
 A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).

Public Attributes

WvConstStringBuffer payloadbuf
IWvStream * cloned
bool disassociate_on_close
WvStreamread_requires_writable
 If this is set, select() doesn't return true for read unless the given stream also returns true for write.
WvStreamwrite_requires_readable
 If this is set, select() doesn't return true for write unless the given stream also returns true for read.
bool uses_continue_select
 If this is set, enables the use of continue_select().
size_t personal_stack_size
 Specifies the stack size to reserve for continue_select().
bool alarm_was_ticking
 This will be true during callback execution if the callback was triggered by the alarm going off.
bool stop_read
 True if noread()/nowrite()/close() have been called, respectively.
bool stop_write

Static Public Attributes

static const int NUM_COMMANDS = EVENT_NOTICE + 1
static const CommandInfo cmdinfos [NUM_COMMANDS]

Protected Member Functions

void _build_selectinfo (SelectInfo &si, time_t msec_timeout, bool readable, bool writable, bool isexcept, bool forceable)
int _do_select (SelectInfo &si)
bool _process_selectinfo (SelectInfo &si, bool forceable)
bool flush_outbuf (time_t msec_timeout)
virtual int getrfd () const
virtual int getwfd () const

Static Protected Member Functions

static void debugger_streams_display_header (WvStringParm cmd, WvStreamsDebugger::ResultCallback result_cb)
static void debugger_streams_display_one_stream (WvStream *s, WvStringParm cmd, WvStreamsDebugger::ResultCallback result_cb)
static void debugger_streams_maybe_display_one_stream (WvStream *s, WvStringParm cmd, const WvStringList &args, WvStreamsDebugger::ResultCallback result_cb)

Protected Attributes

WvLog log
bool closed
int version
WvString my_type
WvDynBuf inbuf
WvDynBuf outbuf
WvStreamCallback callfunc
void * userdata
WvCallback< void *, void * > call_ctx
IWvStreamCallback readcb
IWvStreamCallback writecb
IWvStreamCallback exceptcb
IWvStreamCallback closecb
size_t max_outbuf_size
bool outbuf_delayed_flush
bool is_auto_flush
bool want_to_flush
bool is_flushing
size_t queue_min
time_t autoclose_time
WvTime alarm_time
WvTime last_alarm_check
int errnum
WvString errstring

Static Protected Attributes

static WvStreamglobalstream = NULL

Friends

class WvHTTPClientProxyStream

Classes

struct  CommandInfo

Member Enumeration Documentation

Enumerator:
NONE  used to signal no command received
INVALID  used to signal invalid command
REQ_NOOP  noop ==> OK v18
REQ_GET  get <key> ==> VAL ... OK / FAIL v18
REQ_SET  set <key>

==> OK / FAIL v18

REQ_SETV  setv <key>

v19

REQ_REMOVE  del <key> ==> OK / FAIL v18
REQ_SUBTREE  subt <key> ==> VAL ... OK / FAIL v18
REQ_HASCHILDREN  hchild <key> => HCHILD <key> TRUE / FALSE v18
REQ_COMMIT  commit => OK v18
REQ_REFRESH  refresh => OK / FAIL v18
REQ_QUIT  quit ==> OK v18
REQ_HELP  help ==> TEXT ... OK / FAIL v18
REPLY_OK  OK v18
REPLY_FAIL  FAIL <payload> v18
REPLY_CHILD  HCHILD <key> TRUE / FALSE v18
REPLY_ONEVAL  ONEVAL <key>

v18

PART_VALUE  VAL <key>

v18

PART_TEXT  TEXT <text> v18
EVENT_HELLO  HELLO <message> v18
EVENT_NOTICE  NOTICE <key> <oldval> <newval> v18

Definition at line 49 of file uniclientconn.h.


Constructor & Destructor Documentation

UniClientConn::UniClientConn ( IWvStream *  _s,
WvStringParm  dst = WvString::null 
)

Create a wrapper around the supplied WvStream.

Definition at line 55 of file uniclientconn.cc.


Member Function Documentation

void UniClientConn::close (  )  [virtual]

Close the stream if it is open; isok() becomes false from now on.

Note!! If you override this function in a derived class, you must call it yourself from your destructor. WvStream::~WvStream() can only call WvStream::close() because of the way virtual functions work in C++.

Reimplemented from WvStreamClone.

Reimplemented in UniConfDaemonConn.

Definition at line 70 of file uniclientconn.cc.

References WvStreamClone::close().

Referenced by UniConfDaemonConn::close().

UniClientConn::Command UniClientConn::readcmd (  ) 

Reads a command from the connection.

"command" is the command that was read. The payload is stored in UniClientConn::payloadbuf. Returns: the command code, NONE, or INVALID

Definition at line 120 of file uniclientconn.cc.

Referenced by UniConfDaemonConn::execute().

WvString UniClientConn::readarg (  ) 

Reads the next argument from the command payload.

Returns: the argument or WvString::null

Definition at line 146 of file uniclientconn.cc.

References payloadbuf, and wvtcl_getword().

Referenced by UniConfDaemonConn::execute().

void UniClientConn::writecmd ( UniClientConn::Command  cmd,
WvStringParm  payload = WvString::null 
)

Writes a command to the connection.

"command" is the command "payload" is the payload

Definition at line 152 of file uniclientconn.cc.

References WvStream::write().

Referenced by UniClientGen::commit(), UniClientGen::get(), UniClientGen::haschildren(), UniClientGen::refresh(), UniClientGen::set(), UniClientGen::setv(), writefail(), writeok(), writeonevalue(), writetext(), and writevalue().

void UniClientConn::writeok ( WvStringParm  payload = ""  ) 

Writes a REPLY_OK message.

"payload" is the payload, defaults to ""

Definition at line 161 of file uniclientconn.cc.

References REPLY_OK, and writecmd().

void UniClientConn::writefail ( WvStringParm  payload = ""  ) 

Writes a REPLY_FAIL message.

"payload" is the payload, defaults to ""

Definition at line 167 of file uniclientconn.cc.

References REPLY_FAIL, and writecmd().

void UniClientConn::writevalue ( const UniConfKey key,
WvStringParm  value 
)

Writes a PART_VALUE message.

"key" is the key "value" is the value

Definition at line 173 of file uniclientconn.cc.

References PART_VALUE, spacecat(), writecmd(), and wvtcl_escape().

void UniClientConn::writeonevalue ( const UniConfKey key,
WvStringParm  value 
)

Writes a PART_VALUE message.

"key" is the key "value" is the value

Definition at line 182 of file uniclientconn.cc.

References REPLY_ONEVAL, spacecat(), writecmd(), and wvtcl_escape().

void UniClientConn::writetext ( WvStringParm  text  ) 

Writes a PART_TEXT message.

"text" is the text

Definition at line 188 of file uniclientconn.cc.

References PART_TEXT, writecmd(), and wvtcl_escape().

size_t WvStreamClone::uread ( void *  buf,
size_t  count 
) [virtual, inherited]

unbuffered I/O functions; these ignore the buffer, which is handled by read().

Don't call these functions explicitly unless you have a _really_ good reason.

This is what you would override in a derived class.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, and WvSSLStream.

Definition at line 96 of file wvstreamclone.cc.

References WvStreamClone::close().

size_t WvStreamClone::uwrite ( const void *  buf,
size_t  count 
) [virtual, inherited]

unbuffered I/O functions; these ignore the buffer, which is handled by write().

Don't call these functions explicitly unless you have a _really_ good reason.

This is what you would override in a derived class.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, WvProtoStream, and WvSSLStream.

Definition at line 114 of file wvstreamclone.cc.

Referenced by WvProtoStream::uwrite().

int WvStreamClone::geterr (  )  const [virtual, inherited]

If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.

If isok() is true, returns an undefined number.

Reimplemented from WvErrorBase.

Definition at line 138 of file wvstreamclone.cc.

References WvErrorBase::geterr().

Referenced by WvStreamClone::isok(), and WvSSLStream::~WvSSLStream().

void WvStreamClone::pre_select ( SelectInfo si  )  [virtual, inherited]

pre_select() sets up for eventually calling select().

It adds the right fds to the read, write, and except lists in the SelectInfo struct.

Returns true if we already know this stream is ready, and there's no need to actually do a real select(). Some streams, such as timers, can be implemented by _only_ either returning true or false here after doing a calculation, and never actually adding anything to the SelectInfo.

You can add your stream to any of the lists even if readable, writable, or isexception isn't set. This is what force_select() does. You can also choose not to add yourself to the list if you know it would be useless right now.

pre_select() is only called if isok() is true.

pre_select() is allowed to reduce msec_timeout (or change it if it's -1). However, it's not allowed to _increase_ msec_timeout.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, and WvSSLStream.

Definition at line 189 of file wvstreamclone.cc.

References IWvStream::SelectInfo::inherit_request, IWvStream::SelectRequest::isexception, WvStream::pre_select(), IWvStream::SelectRequest::readable, WvBufBaseCommonImpl< T >::used(), IWvStream::SelectInfo::wants, and IWvStream::SelectRequest::writable.

Referenced by WvSSLStream::pre_select(), and WvEncoderStream::pre_select().

bool WvStreamClone::post_select ( SelectInfo si  )  [virtual, inherited]

post_select() is called after select(), and returns true if this object is now ready.

Usually this is done by checking for this object in the read, write, and except lists in the SelectInfo structure. If you want to do it in some other way, you should usually do it in pre_select() instead.

You may also want to do extra maintenance functions here; for example, the standard WvStream::post_select tries to flush outbuf if it's nonempty. WvTCPConn might retry connect() if it's waiting for a connection to be established.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, and WvSSLStream.

Definition at line 212 of file wvstreamclone.cc.

References WvStream::flush(), IWvStream::SelectInfo::inherit_request, IWvStream::SelectRequest::isexception, WvStream::post_select(), WvStream::read_requires_writable, IWvStream::SelectRequest::readable, WvStream::select(), WvBufBaseCommonImpl< T >::used(), IWvStream::SelectInfo::wants, IWvStream::SelectRequest::writable, and WvStream::write_requires_readable.

Referenced by WvSSLStream::post_select(), and WvEncoderStream::post_select().

const WvAddr * WvStreamClone::src (  )  const [virtual, inherited]

get the remote address from which the last data block was received.

May be NULL. The pointer becomes invalid upon the next call to read().

Reimplemented from WvStream.

Definition at line 254 of file wvstreamclone.cc.

void WvStreamClone::execute (  )  [virtual, inherited]

The callback() function calls execute(), and then calls the user- specified callback if one is defined.

Do not call execute() directly; call callback() instead.

The default execute() function does nothing.

Note: If you override this function in a derived class, you must call the parent execute() yourself from the derived class.

Reimplemented from WvStream.

Reimplemented in UniConfDaemonConn, and WvProtoStream.

Definition at line 262 of file wvstreamclone.cc.

References WvStream::execute().

Referenced by WvProtoStream::execute(), and UniConfDaemonConn::execute().

void WvStream::seterr ( int  _errnum  )  [virtual, inherited]

size_t WvStream::read ( void *  buf,
size_t  count 
) [virtual, inherited]

size_t WvStream::read ( WvBuf outbuf,
size_t  count 
) [virtual, inherited]

Reads up to 'count' bytes of data from the stream into the buffer.

Returns the actual amount read.

If 'count' is greater than the amount of free space available in the buffer, only reads at most that amount. You should specify a reasonable upper bound on how much data should be read at once.

Definition at line 426 of file wvstream.cc.

References WvBufBaseCommonImpl< T >::alloc(), WvBufBaseCommonImpl< T >::free(), WvBufBaseCommonImpl< T >::merge(), WvStream::read(), and WvBufBaseCommonImpl< T >::unalloc().

void WvStream::unread ( WvBuf outbuf,
size_t  count 
) [virtual, inherited]

Puts data back into the stream's internal buffer.

We cheat so that there's no restriction on how much (or what) data can be unread(). This is different from WvBuf::unget() (which is rather restrictive).

Definition at line 1160 of file wvstream.cc.

References WvBufBaseCommonImpl< T >::merge(), and WvBufBaseCommonImpl< T >::zap().

size_t WvStream::write ( const void *  buf,
size_t  count 
) [virtual, inherited]

Write data to the stream.

Returns the actual amount written. Since WvStream has an output buffer, it *always* successfully "writes" the full amount (but you might have to flush the buffers later so it actually gets sent).

Definition at line 497 of file wvstream.cc.

References WvStream::flush(), WvStream::isok(), WvBufBase< unsigned char >::put(), WvBufBaseCommonImpl< T >::used(), and WvStream::uwrite().

Referenced by WvLogFileBase::_mid_line(), WvModem::close(), WvIStreamList::execute(), WvModemBase::hangup(), WvLog::operator()(), WvStream::print(), UniFileSystemGen::set(), WvProtoStream::uwrite(), WvFdStream::uwrite(), WvDsp::uwrite(), WvStream::write(), and writecmd().

size_t WvStream::write ( WvBuf inbuf,
size_t  count = INT_MAX 
) [virtual, inherited]

Writes data to the stream from the given buffer.

Returns the actual amount written.

If count is greater than the amount of data available in the buffer, only writes at most that amount.

Definition at line 442 of file wvstream.cc.

References WvBufBaseCommonImpl< T >::get(), WvBufBaseCommonImpl< T >::unget(), WvBufBaseCommonImpl< T >::used(), and WvStream::write().

size_t WvStream::write ( WvStringParm  s  )  [inline, inherited]

print a preformatted WvString to the stream.

see the simple version of write() way up above.

Definition at line 538 of file wvstream.h.

References WvFastString::cstr(), WvFastString::len(), and WvStream::write().

void WvStream::outbuf_limit ( size_t  size  )  [inline, inherited]

set the maximum size of outbuf, beyond which a call to write() will return 0.

I need to do this for tape backups, since all I can do is write to the loopback as fast as I can, which causes us to run out of memory and get SIGABRT'd. (dcoombs: 12/15/2000)

FIXME: there must be a better way. This confuses the semantics of write(); can you trust it to always write all the bytes, or not?

Definition at line 129 of file wvstream.h.

char* WvStream::getline ( time_t  wait_msec = 0,
char  separator = '\n',
int  readahead = 1024 
) [inline, inherited]

Read up to one line of data from the stream and return a pointer to the internal buffer containing this line.

If the end-of-line 'separator' is encountered, it is removed from the string. If there is not a full line available, returns NULL. You can read what we have so far by calling read().

Readahead specifies the maximum amount of data that the stream is allowed to read in one shot.

It is expected that there will be no NULL characters on the line.

wait_msec is provided so that legacy code does not break. But it really should be 0.

Definition at line 175 of file wvstream.h.

References WvStream::blocking_getline().

Referenced by WvProtoStream::execute(), WvIPRouteList::get_kernel(), and WvStream::getline().

char* WvStream::getline ( int  wait_msec,
char  separator = '\n',
int  readahead = 1024 
) [inline, inherited]

Auto-convert int to time_t.

Definition at line 182 of file wvstream.h.

References WvStream::getline().

char* WvStream::getline ( double  wait_msec,
char  separator = '\n',
int  readahead = 1024 
) [inline, inherited]

Auto-convert double to time_t.

Definition at line 189 of file wvstream.h.

References WvStream::getline().

char * WvStream::blocking_getline ( time_t  wait_msec,
int  separator = '\n',
int  readahead = 1024 
) [inherited]

This is a version of getline() that allows you to block for more data to arrive.

This should be used carefully, as blocking is generally unexpected in WvStreams programs.

If wait_msec < 0, it will wait forever for the 'separator' (often a bad idea!). If wait_msed == 0, this is the equivalent of getline().

Definition at line 567 of file wvstream.cc.

References WvBufBaseCommonImpl< T >::alloc(), WvStream::continue_select(), WvBufBaseCommonImpl< T >::get(), WvStream::isok(), WvBufBaseCommonImpl< T >::mutablepeek(), WvBufBase< unsigned char >::put(), WvStream::queuemin(), WvStream::select(), WvStream::stop_read, WvBufBase< unsigned char >::strchr(), WvBufBaseCommonImpl< T >::unalloc(), WvStream::uread(), WvBufBaseCommonImpl< T >::used(), and WvStream::uses_continue_select.

Referenced by WvIPRouteList::get_kernel(), WvStream::getline(), and UniIniGen::refresh().

void WvStream::queuemin ( size_t  count  )  [inline, inherited]

force read() to not return any bytes unless 'count' bytes can be read at once.

(Useful for processing Content-Length headers, etc.) Use count==0 to disable this feature.

WARNING: getline() sets queuemin to 0 automatically!

Definition at line 232 of file wvstream.h.

Referenced by WvStream::blocking_getline().

void WvStream::delay_output ( bool  is_delayed  )  [inline, inherited]

force write() to always buffer output.

This can be more efficient if you write a lot of small segments and want to "coagulate" them automatically. To flush the output buffer, use flush() or select().

Definition at line 246 of file wvstream.h.

void WvStream::auto_flush ( bool  is_automatic  )  [inline, inherited]

if true, force write() to call flush() each time, the default behavour.

otherwise, flush() is granted special meaning when explicitly invoked by the client and write() may empty the output buffer, but will not explicitly flush().

Definition at line 258 of file wvstream.h.

bool WvStream::flush ( time_t  msec_timeout  )  [virtual, inherited]

flush the output buffer, if we can do it without delaying more than msec_timeout milliseconds at a time.

(-1 means wait forever)

Returns true if the flushing finished (the output buffer is empty).

Definition at line 672 of file wvstream.cc.

Referenced by WvLogFileBase::_end_line(), WvStream::close(), WvStream::flush_then_close(), WvStreamClone::post_select(), WvStream::post_select(), and WvStream::write().

void WvStream::flush_then_close ( int  msec_timeout  )  [inherited]

flush the output buffer automatically as select() is called.

If the buffer empties, close the stream. If msec_timeout seconds pass, close the stream. After the stream closes, it will become !isok() (and a WvStreamList can delete it automatically)

Definition at line 792 of file wvstream.cc.

References WvStream::flush(), and WvBufBaseCommonImpl< T >::used().

void WvStream::xpre_select ( SelectInfo si,
const SelectRequest r 
) [inline, inherited]

Like pre_select(), but still exists even if you override the other pre_select() in a subclass.

Sigh.

Definition at line 318 of file wvstream.h.

References WvStream::pre_select().

bool WvStream::xpost_select ( SelectInfo si,
const SelectRequest r 
) [inline, inherited]

Like post_select(), but still exists even if you override the other post_select() in a subclass.

Sigh.

Definition at line 339 of file wvstream.h.

References WvStream::post_select().

bool WvStream::select ( time_t  msec_timeout  )  [inline, inherited]

Return true if any of the requested features are true on the stream.

If msec_timeout < 0, waits forever (bad idea!). ==0, does not wait. Otherwise, waits for up to msec_timeout milliseconds.

**NOTE** select() is _not_ virtual! To change the select() behaviour of a stream, override the pre_select() and/or post_select() functions.

This version of select() sets forceable==true, so force_select options are taken into account.

You almost always use this version of select() with callbacks, like this: if (stream.select(1000)) stream.callback();

If you want to read/write the stream in question, try using the other variant of select().

DEPRECATED. Call runonce() instead.

Definition at line 376 of file wvstream.h.

Referenced by WvStream::blocking_getline(), WvStream::continue_select(), WvModemBase::hangup(), WvStreamClone::post_select(), WvFdStream::post_select(), and WvStream::runonce().

bool WvStream::select ( time_t  msec_timeout,
bool  readable,
bool  writable,
bool  isex = false 
) [inline, inherited]

This version of select() sets forceable==false, so we use the exact readable/writable/isexception options provided.

You normally use this variant of select() when deciding whether you should read/write a particular stream. For example:

if (stream.select(1000, true, false)) len = stream.read(buf, sizeof(buf));

This variant of select() is probably not what you want with most WvStreamLists, unless you know exactly what you're doing.

WARNING: the difference between the one-parameter and multi-parameter versions of select() is *incredibly* confusing. Make sure you use the right one!

DEPRECATED. Call isreadable() or iswritable() instead, if msec_timeout was going to be zero. Other values of msec_timeout are not really recommended anyway.

Definition at line 415 of file wvstream.h.

void WvStream::runonce ( time_t  msec_timeout = -1  )  [inline, inherited]

Exactly the same as: if (select(timeout)) callback();.

...except that the above is deprecated, because it assumes callbacks aren't called automatically and that the return value of one-parameter select() is actually meaningful.

Update your main loop to call runonce() instead of the above.

Almost all modern programs should use msec_timeout = -1.

Definition at line 391 of file wvstream.h.

References WvStream::callback(), and WvStream::select().

IWvStream::SelectRequest WvStream::get_select_request (  )  [inherited]

Use get_select_request() to save the current state of the selection state of this stream.

That way, you can call force_select() and undo_force_select() to restore this properly.

Definition at line 991 of file wvstream.cc.

void WvStream::force_select ( bool  readable,
bool  writable,
bool  isexception = false 
) [inherited]

Use force_select() to force one or more particular modes (readable, writable, or isexception) to true when selecting on this stream.

If an option is set 'true', we will select on that option when someone does a select(). If it's set 'false', we don't change its force status. (To de-force something, use undo_force_select().)

Definition at line 997 of file wvstream.cc.

Referenced by WvStreamClone::WvStreamClone().

void WvStream::undo_force_select ( bool  readable,
bool  writable,
bool  isexception = false 
) [inherited]

Undo a previous force_select() - ie.

un-forces the options which are 'true', and leaves the false ones alone.

Definition at line 1008 of file wvstream.cc.

bool WvStream::continue_select ( time_t  msec_timeout  )  [inherited]

return to the caller from execute(), but don't really return exactly; this uses WvCont::yield() to return to the caller of callback() without losing our place in execute() itself.

So, next time someone calls callback(), it will be as if continue_select() returned.

NOTE: execute() will won't be called recursively this way, but any other member function might get called, or member variables changed, or the state of the world updated while continue_select() runs. Don't assume that nothing has changed after a call to continue_select().

NOTE 2: if you're going to call continue_select(), you should set uses_continue_select=true before the first call to callback(). Otherwise your WvCont won't get created.

NOTE 3: if msec_timeout >= 0, this uses WvStream::alarm().

Definition at line 1059 of file wvstream.cc.

References WvStream::alarm(), WvStream::alarm_was_ticking, WvStream::select(), WvStream::uses_continue_select, and WvCont::yield().

Referenced by WvStream::blocking_getline().

IWvStreamCallback WvStream::setreadcallback ( IWvStreamCallback  _callback  )  [inherited]

Sets a callback to be invoked when the stream is readable.

Definition at line 1114 of file wvstream.cc.

IWvStreamCallback WvStream::setwritecallback ( IWvStreamCallback  _callback  )  [inherited]

Sets a callback to be invoked when the stream is writable.

Definition at line 1124 of file wvstream.cc.

IWvStreamCallback WvStream::setexceptcallback ( IWvStreamCallback  _callback  )  [inherited]

Sets a callback to be invoked when the stream is in exception state.

Definition at line 1134 of file wvstream.cc.

IWvStreamCallback WvStream::setclosecallback ( IWvStreamCallback  _callback  )  [inherited]

Sets a callback to be invoked on close().

Definition at line 1144 of file wvstream.cc.

References WvStream::_callback(), and WvStream::isok().

void WvStream::noautoforward (  )  [inherited]

Stops autoforwarding.

Definition at line 331 of file wvstream.cc.

References WvStream::read_requires_writable, and WvStream::setcallback().

void WvStream::callback (  )  [virtual, inherited]

if the stream has a callback function defined, call it now.

otherwise call execute().

Definition at line 365 of file wvstream.cc.

References WvStream::_callback(), WvStream::_callwrap(), WvStream::alarm_remaining(), WvStream::alarm_was_ticking, WvStream::personal_stack_size, and WvStream::uses_continue_select.

Referenced by UniClientGen::flush_buffers(), and WvStream::runonce().

void WvStream::alarm ( time_t  msec_timeout  )  [inherited]

set an alarm, ie.

select() will return true after this many ms. The alarm is cleared when callback() is called.

Definition at line 1019 of file wvstream.cc.

Referenced by WvStream::continue_select(), WvSubProcQueueStream::execute(), and WvUnixDGSocket::post_select().

size_t WvStream::print ( WVSTRING_FORMAT_DECL   )  [inline, inherited]

preformat and write() a string.

Definition at line 546 of file wvstream.h.

References WvStream::write().

void WvErrorBase::noerr (  )  [inline, inherited]

Reset our error state - there's no error condition anymore.

Definition at line 76 of file wverror.h.

virtual unsigned int IObject::addRef (  )  [pure virtual, inherited]

Indicate you are using this object.

This increases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

This called a "strong reference", because they will prevent the object from being destroyed. They should thus be used carefully, as they control the lifetime of the object. For example, you do not need to call addRef() on object passed as parameters, unless you intend on keeping them.

addRef() is often called automatically for you in XPLC, but you'll have to call release() by hand sometimes unless you use xplc_ptr.

Referenced by IObjectImplInternal::getInterface(), and WeakRef::getObject().

virtual unsigned int IObject::release (  )  [pure virtual, inherited]

Indicate that you are finished using this object.

This decreases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

You will usually need to manually release() any object given to you by any other XPLC function, unless you give the object to someone else who will call release.

If you use xplc_ptr, it will do this for you.

Referenced by mutate().

virtual IObject* IObject::getInterface ( const UUID  )  [pure virtual, inherited]

Returns the requested XPLC interface.

Will return NULL if the interface is not supported. The returned interface has been addRef()ed, so you will need to release() it when done. Note that the interface returned may be a pointer to the same object or a different one - that's none of your business. Asking for the IObject interface should always return the same pointer for a given logical object, so this can be used for comparison by identity.

You should probably use the convenient mutate() and get() functions instead of this, or use an xplc_ptr, which mutates the object for you.

Referenced by mutate().

virtual IWeakRef* IObject::getWeakRef (  )  [pure virtual, inherited]

Return a weak reference to this object.

A weak reference points at the object, but does not control the lifetime of the object. An object can thus still be deleted while someone holds a weak reference. You will still need to release() the weak reference when you are done with it.

See also:
IWeakRef


Member Data Documentation

holds the previous command payload

Definition at line 37 of file uniclientconn.h.

Referenced by readarg().

const UniClientConn::CommandInfo UniClientConn::cmdinfos [static]

Initial value:

 {
    
    { "noop", "noop: verify that the connection is active" },
    { "get", "get <key>: get the value of a key" },
    { "set", "set <key> <value>: sets the value of a key" },
    { "setv", "setv <key> <value> ...: set multiple key-value pairs" },
    { "del", "del <key>: deletes the key" },
    { "subt", "subt <key> <recurse?>: enumerates the children of a key" },
    { "hchild", "hchild <key>: returns whether a key has children" },
    { "commit", "commit: commits changes to disk" },
    { "refresh", "refresh: refresh contents from disk" },
    { "quit", "quit: kills the session nicely" },
    { "help", "help: returns this help text" },

    
    { "OK", "OK <payload>: reply on command success" },
    { "FAIL", "FAIL <payload>: reply on command failure" },
    { "CHILD", "CHILD <key> TRUE / FALSE: key has children or not" },
    { "ONEVAL", "ONEVAL <key> <value>: reply to a get" },

    
    { "VAL", "VAL <key> <value>: intermediate reply value of a key" },
    { "TEXT", "TEXT <text>: intermediate reply of a text message" },

    
    { "HELLO", "HELLO <version> <message>: sent by server on connection" },
    { "NOTICE", "NOTICE <key> <oldval> <newval>: forget key and its children" },
}

Definition at line 87 of file uniclientconn.h.

If this is set, enables the use of continue_select().

Definition at line 45 of file wvstream.h.

Referenced by WvStream::blocking_getline(), WvStream::callback(), WvStream::continue_getline(), and WvStream::continue_select().

size_t WvStream::personal_stack_size [inherited]

Specifies the stack size to reserve for continue_select().

Definition at line 48 of file wvstream.h.

Referenced by WvStream::callback().

bool WvStream::stop_read [inherited]

True if noread()/nowrite()/close() have been called, respectively.

Definition at line 57 of file wvstream.h.

Referenced by WvStream::blocking_getline(), WvSSLStream::close(), and WvSSLStream::uread().


The documentation for this class was generated from the following files:

Generated on Sat Feb 7 13:37:18 2009 for WvStreams by  doxygen 1.5.6