WvStreams
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
UniConfDaemonConn Class Referenceabstract

Retains all state and behavior related to a single UniConf daemon connection. More...

#include <uniconfdaemonconn.h>

Inheritance diagram for UniConfDaemonConn:
Inheritance graph
[legend]

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 , 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
}
 
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 , 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

 UniConfDaemonConn (WvStream *s, const UniConf &root)
 
virtual void close ()
 Close this stream.
 
virtual void execute ()
 The callback() function calls execute(), and then calls the user- specified callback if one is defined.
 
 UniConfDaemonConn (WvStream *s, const UniConf &root)
 
virtual void close ()
 Close this stream.
 
virtual void execute ()
 The callback() function calls execute(), and then calls the user- specified callback if one is defined.
 
Command readcmd ()
 Reads a command from the connection.
 
Command readcmd (WvString &command)
 
Command readcmd ()
 Reads a command from the connection.
 
Command readcmd (WvString &command)
 
WvString readarg ()
 Reads the next argument from the command payload.
 
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 writecmd (Command command, WvStringParm payload=WvString::null)
 Writes a command to the connection.
 
void writeok (WvStringParm payload="")
 Writes a REPLY_OK message.
 
void writeok (WvStringParm payload="")
 Writes a REPLY_OK message.
 
void writefail (WvStringParm payload="")
 Writes a REPLY_FAIL message.
 
void writefail (WvStringParm payload="")
 Writes a REPLY_FAIL message.
 
void writevalue (const UniConfKey &key, WvStringParm value)
 Writes a PART_VALUE 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 writeonevalue (const UniConfKey &key, WvStringParm value)
 Writes a PART_VALUE message.
 
void writetext (WvStringParm text)
 Writes a PART_TEXT message.
 
void writetext (WvStringParm text)
 Writes a PART_TEXT message.
 
virtual void setclone (IWvStream *clone)
 WvStreamClone takes ownership of the given stream; it will WVRELEASE() the stream when you setclone() it to something else or destroy this object.
 
virtual void setclone (IWvStream *clone)
 WvStreamClone takes ownership of the given stream; it will WVRELEASE() the stream when you setclone() it to something else or destroy this object.
 
virtual bool flush_internal (time_t msec_timeout)
 WvStream overrides.
 
virtual bool flush_internal (time_t msec_timeout)
 WvStream overrides.
 
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 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 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 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 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 WvString errstr () const
 
virtual void pre_select (SelectInfo &si)
 pre_select() sets up for eventually calling select().
 
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.
 
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 const WvAddrsrc () const
 get the remote address from which the last data block was received.
 
virtual void noread ()
 Shuts down the reading side of the stream.
 
virtual void noread ()
 Shuts down the reading side of the stream.
 
virtual void nowrite ()
 Shuts down the writing side of the stream.
 
virtual void nowrite ()
 Shuts down the writing side of the stream.
 
virtual WvString getattr (WvStringParm name) const
 
virtual WvString getattr (WvStringParm name) const
 
const char * wstype () const
 
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)
 
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 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 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.
 
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.
 
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 ()
 Auto-close the stream if the time is right.
 
virtual void maybe_autoclose ()
 Auto-close the stream if the time is right.
 
virtual bool isreadable ()
 Returns true if the stream is readable.
 
virtual bool isreadable ()
 Returns true if the stream is readable.
 
virtual bool iswritable ()
 Returns true if the stream is writable (without using the outbuf).
 
virtual bool iswritable ()
 Returns true if the stream is writable (without using the outbuf).
 
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 * 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 * 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.
 
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 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 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 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.
 
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 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 ()
 Returns true if we want to flush the output buffer right now.
 
virtual bool should_flush ()
 Returns true if we want to flush the output buffer right now.
 
void flush_then_close (int msec_timeout)
 flush the output buffer automatically as select() is called.
 
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.
 
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 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.
 
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();.
 
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.
 
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 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.
 
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.
 
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 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 (IWvStreamCallback _callfunc)
 define the callback function for this stream, called whenever the callback() member is run, and passed the 'userdata' pointer.
 
void setcallback (IWvStreamCallback _callfunc)
 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 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 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 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().
 
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 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 noautoforward ()
 Stops autoforwarding.
 
void * _callwrap (void *)
 A wrapper that's compatible with WvCont, but calls the "real" callback.
 
void * _callwrap (void *)
 A wrapper that's compatible with WvCont, but calls the "real" callback.
 
void _callback ()
 Actually call the registered callfunc and execute().
 
void _callback ()
 Actually call the registered callfunc and execute().
 
virtual void callback ()
 if the stream has a callback function defined, call it now.
 
virtual void callback ()
 if the stream has a callback function defined, call it now.
 
void alarm (time_t msec_timeout)
 set an alarm, ie.
 
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().
 
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 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)
 
size_t operator() (WvStringParm s)
 
size_t operator() (WVSTRING_FORMAT_DECL)
 
const char * wsname () const
 
const char * wsname () const
 
void set_wsname (WvStringParm wsname)
 
void set_wsname (WVSTRING_FORMAT_DECL)
 
void set_wsname (WvStringParm wsname)
 
void set_wsname (WVSTRING_FORMAT_DECL)
 
WSID wsid () const
 
WSID wsid () const
 
void seterr_both (int _errnum, WvStringParm specialerr)
 
void seterr_both (int _errnum, WVSTRING_FORMAT_DECL)
 
void seterr_both (int _errnum, WvStringParm specialerr)
 
void seterr_both (int _errnum, WVSTRING_FORMAT_DECL)
 
void noerr ()
 Reset our error state - there's no error condition anymore.
 
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 addRef ()=0
 Indicate you are using this object.
 
virtual unsigned int release ()=0
 Indicate that you are finished 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 IObjectgetInterface (const UUID &)=0
 Returns the requested XPLC interface.
 
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.
 
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.
 

Static Public Member Functions

static void autoforward_callback (WvStream &input, WvStream &output)
 
static void autoforward_callback (WvStream &input, WvStream &output)
 
static IWvStreamfind_by_wsid (WSID wsid)
 
static IWvStreamfind_by_wsid (WSID wsid)
 
static IWvStreamcreate (WvStringParm moniker, IObject *obj=NULL)
 
static IWvStreamcreate (WvStringParm moniker, IObject *obj=NULL)
 
static WvString strerror (int errnum)
 A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).
 
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
 
IWvStreamcloned
 
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

virtual void do_invalid (WvStringParm c)
 
virtual void do_malformed (UniClientConn::Command)
 
virtual void do_noop ()
 
virtual void do_reply (WvStringParm reply)
 
virtual void do_get (const UniConfKey &key)
 
virtual void do_set (const UniConfKey &key, WvStringParm value)
 
virtual void do_remove (const UniConfKey &key)
 
virtual void do_subtree (const UniConfKey &key, bool recursive)
 
virtual void do_haschildren (const UniConfKey &key)
 
virtual void do_commit ()
 
virtual void do_refresh ()
 
virtual void do_quit ()
 
virtual void do_help ()
 
virtual void addcallback ()
 
virtual void delcallback ()
 
void deltacallback (const UniConf &cfg, const UniConfKey &key)
 
virtual void do_invalid (WvStringParm c)
 
virtual void do_malformed (UniClientConn::Command)
 
virtual void do_noop ()
 
virtual void do_reply (WvStringParm reply)
 
virtual void do_get (const UniConfKey &key)
 
virtual void do_set (const UniConfKey &key, WvStringParm value)
 
virtual void do_remove (const UniConfKey &key)
 
virtual void do_subtree (const UniConfKey &key, bool recursive)
 
virtual void do_haschildren (const UniConfKey &key)
 
virtual void do_commit ()
 
virtual void do_refresh ()
 
virtual void do_quit ()
 
virtual void do_help ()
 
virtual void addcallback ()
 
virtual void delcallback ()
 
void deltacallback (const UniConf &cfg, const UniConfKey &key)
 
void setattr (WvStringParm name, WvStringParm value)
 
void setattr (WvStringParm name, WvStringParm value)
 
void _build_selectinfo (SelectInfo &si, time_t msec_timeout, bool readable, bool writable, bool isexcept, bool forceable)
 
void _build_selectinfo (SelectInfo &si, time_t msec_timeout, bool readable, bool writable, bool isexcept, bool forceable)
 
int _do_select (SelectInfo &si)
 
int _do_select (SelectInfo &si)
 
bool _process_selectinfo (SelectInfo &si, bool forceable)
 
bool _process_selectinfo (SelectInfo &si, bool forceable)
 
bool flush_outbuf (time_t msec_timeout)
 
bool flush_outbuf (time_t msec_timeout)
 
virtual int getrfd () const
 
virtual int getrfd () const
 
virtual int getwfd () 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_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_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)
 
static void debugger_streams_maybe_display_one_stream (WvStream *s, WvStringParm cmd, const WvStringList &args, WvStreamsDebugger::ResultCallback result_cb)
 

Protected Attributes

UniConf root
 
WvLog log
 
bool closed
 
int version
 
WvString my_type
 
WvDynBuf inbuf
 
WvDynBuf outbuf
 
IWvStreamCallback callfunc
 
wv::function< 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
 

Detailed Description

Retains all state and behavior related to a single UniConf daemon connection.

Definition at line 25 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconfdaemonconn.h.

Member Enumeration Documentation

◆ Command [1/2]

enum UniClientConn::Command
inherited
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

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 debian/libwvstreams-dev/usr/include/wvstreams/uniclientconn.h.

◆ Command [2/2]

enum UniClientConn::Command
inherited
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

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 include/uniclientconn.h.

Constructor & Destructor Documentation

◆ UniConfDaemonConn()

UniConfDaemonConn::UniConfDaemonConn ( WvStream s,
const UniConf root 
)

Definition at line 15 of file uniconfdaemonconn.cc.

◆ ~UniConfDaemonConn()

UniConfDaemonConn::~UniConfDaemonConn ( )
virtual

Definition at line 26 of file uniconfdaemonconn.cc.

Member Function Documentation

◆ close() [1/2]

void UniConfDaemonConn::close ( )
virtual

Close this stream.

Note that this does close the inner stream. However, see ~WvStreamClone() for a note about destroying vs. closing the stream.

Reimplemented from UniClientConn.

Definition at line 34 of file uniconfdaemonconn.cc.

References UniClientConn::close().

◆ execute() [1/2]

void UniConfDaemonConn::execute ( )
virtual

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 WvStreamClone.

Definition at line 53 of file uniconfdaemonconn.cc.

References WvStream::execute(), UniClientConn::INVALID, WvFastString::isnull(), UniClientConn::NONE, WvFastString::num(), UniClientConn::readarg(), UniClientConn::readcmd(), UniClientConn::REQ_COMMIT, UniClientConn::REQ_GET, UniClientConn::REQ_HASCHILDREN, UniClientConn::REQ_HELP, UniClientConn::REQ_NOOP, UniClientConn::REQ_QUIT, UniClientConn::REQ_REFRESH, UniClientConn::REQ_REMOVE, UniClientConn::REQ_SET, and UniClientConn::REQ_SUBTREE.

◆ do_invalid()

void UniConfDaemonConn::do_invalid ( WvStringParm  c)
protectedvirtual

Definition at line 137 of file uniconfdaemonconn.cc.

◆ do_malformed()

void UniConfDaemonConn::do_malformed ( UniClientConn::Command  c)
protectedvirtual

Definition at line 143 of file uniconfdaemonconn.cc.

◆ do_noop()

void UniConfDaemonConn::do_noop ( )
protectedvirtual

Definition at line 150 of file uniconfdaemonconn.cc.

◆ do_reply()

void UniConfDaemonConn::do_reply ( WvStringParm  reply)
protectedvirtual

Definition at line 156 of file uniconfdaemonconn.cc.

◆ do_get()

void UniConfDaemonConn::do_get ( const UniConfKey key)
protectedvirtual

Definition at line 162 of file uniconfdaemonconn.cc.

◆ do_set()

void UniConfDaemonConn::do_set ( const UniConfKey key,
WvStringParm  value 
)
protectedvirtual

Definition at line 173 of file uniconfdaemonconn.cc.

◆ do_remove()

void UniConfDaemonConn::do_remove ( const UniConfKey key)
protectedvirtual

Definition at line 179 of file uniconfdaemonconn.cc.

◆ do_subtree()

void UniConfDaemonConn::do_subtree ( const UniConfKey key,
bool  recursive 
)
protectedvirtual

Definition at line 232 of file uniconfdaemonconn.cc.

◆ do_haschildren()

void UniConfDaemonConn::do_haschildren ( const UniConfKey key)
protectedvirtual

Definition at line 277 of file uniconfdaemonconn.cc.

◆ do_commit()

void UniConfDaemonConn::do_commit ( )
protectedvirtual

Definition at line 285 of file uniconfdaemonconn.cc.

◆ do_refresh()

void UniConfDaemonConn::do_refresh ( )
protectedvirtual

Definition at line 292 of file uniconfdaemonconn.cc.

◆ do_quit()

void UniConfDaemonConn::do_quit ( )
protectedvirtual

Definition at line 301 of file uniconfdaemonconn.cc.

◆ do_help()

void UniConfDaemonConn::do_help ( )
protectedvirtual

Definition at line 308 of file uniconfdaemonconn.cc.

◆ addcallback()

void UniConfDaemonConn::addcallback ( )
protectedvirtual

Definition at line 40 of file uniconfdaemonconn.cc.

◆ delcallback()

void UniConfDaemonConn::delcallback ( )
protectedvirtual

Definition at line 47 of file uniconfdaemonconn.cc.

◆ deltacallback()

void UniConfDaemonConn::deltacallback ( const UniConf cfg,
const UniConfKey key 
)
protected

Definition at line 316 of file uniconfdaemonconn.cc.

◆ close() [2/2]

virtual void UniConfDaemonConn::close ( )
virtual

Close this stream.

Note that this does close the inner stream. However, see ~WvStreamClone() for a note about destroying vs. closing the stream.

Reimplemented from UniClientConn.

◆ execute() [2/2]

virtual void UniConfDaemonConn::execute ( )
virtual

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 WvStreamClone.

◆ readcmd() [1/3]

UniClientConn::Command UniClientConn::readcmd ( )
inherited

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.

References UniClientConn::readcmd().

Referenced by execute(), and UniClientConn::readcmd().

◆ readcmd() [2/3]

UniClientConn::Command UniClientConn::readcmd ( WvString command)
inherited

Definition at line 126 of file uniclientconn.cc.

◆ readcmd() [3/3]

Command UniClientConn::readcmd ( )
inherited

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

◆ readarg() [1/2]

WvString UniClientConn::readarg ( )
inherited

Reads the next argument from the command payload.

Returns: the argument or WvString::null

Definition at line 146 of file uniclientconn.cc.

References UniClientConn::payloadbuf, and wvtcl_getword().

Referenced by execute().

◆ readarg() [2/2]

WvString UniClientConn::readarg ( )
inherited

Reads the next argument from the command payload.

Returns: the argument or WvString::null

◆ writecmd() [1/2]

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

◆ writecmd() [2/2]

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

Writes a command to the connection.

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

◆ writeok() [1/2]

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

Writes a REPLY_OK message.

"payload" is the payload, defaults to ""

Definition at line 161 of file uniclientconn.cc.

References UniClientConn::REPLY_OK, and UniClientConn::writecmd().

◆ writeok() [2/2]

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

Writes a REPLY_OK message.

"payload" is the payload, defaults to ""

◆ writefail() [1/2]

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

Writes a REPLY_FAIL message.

"payload" is the payload, defaults to ""

Definition at line 167 of file uniclientconn.cc.

References UniClientConn::REPLY_FAIL, and UniClientConn::writecmd().

◆ writefail() [2/2]

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

Writes a REPLY_FAIL message.

"payload" is the payload, defaults to ""

◆ writevalue() [1/2]

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

Writes a PART_VALUE message.

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

Definition at line 173 of file uniclientconn.cc.

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

◆ writevalue() [2/2]

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

Writes a PART_VALUE message.

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

◆ writeonevalue() [1/2]

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

Writes a PART_VALUE message.

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

Definition at line 182 of file uniclientconn.cc.

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

◆ writeonevalue() [2/2]

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

Writes a PART_VALUE message.

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

◆ writetext() [1/2]

void UniClientConn::writetext ( WvStringParm  text)
inherited

Writes a PART_TEXT message.

"text" is the text

Definition at line 188 of file uniclientconn.cc.

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

◆ writetext() [2/2]

void UniClientConn::writetext ( WvStringParm  text)
inherited

Writes a PART_TEXT message.

"text" is the text

◆ setclone() [1/2]

void WvStreamClone::setclone ( IWvStream clone)
virtualinherited

WvStreamClone takes ownership of the given stream; it will WVRELEASE() the stream when you setclone() it to something else or destroy this object.

If this is undesirable, you should addRef() the stream before passing it in here.

Note: setclone() changes the cloned stream's various callbacks. It removes the callbacks from the old stream when you setclone() to something else. This means it is not safe to clone the same stream more than once at a time, but it is safe to un-clone and then re-clone a stream (as long as you watch its reference count).

Note: calling setclone() more than once on the same stream can cause weird interactions with buffering. Be careful. It is often best to flush your output buffer before calling setclone().

Reimplemented in WvQtStreamClone, WvQtStreamClone, WvWinStreamClone, and WvWinStreamClone.

Definition at line 181 of file wvstreamclone.cc.

References IWvStream::setclosecallback(), and WvStream::stop_read.

Referenced by WvQtStreamClone::setclone(), WvWinStreamClone::setclone(), WvStreamClone::WvStreamClone(), and WvStreamClone::~WvStreamClone().

◆ setclone() [2/2]

virtual void WvStreamClone::setclone ( IWvStream clone)
virtualinherited

WvStreamClone takes ownership of the given stream; it will WVRELEASE() the stream when you setclone() it to something else or destroy this object.

If this is undesirable, you should addRef() the stream before passing it in here.

Note: setclone() changes the cloned stream's various callbacks. It removes the callbacks from the old stream when you setclone() to something else. This means it is not safe to clone the same stream more than once at a time, but it is safe to un-clone and then re-clone a stream (as long as you watch its reference count).

Note: calling setclone() more than once on the same stream can cause weird interactions with buffering. Be careful. It is often best to flush your output buffer before calling setclone().

Reimplemented in WvQtStreamClone, WvQtStreamClone, WvWinStreamClone, and WvWinStreamClone.

◆ flush_internal() [1/2]

bool WvStreamClone::flush_internal ( time_t  msec_timeout)
virtualinherited

WvStream overrides.

These generally just call the cloned stream's version.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, and WvEncoderStream.

Definition at line 94 of file wvstreamclone.cc.

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

Referenced by WvEncoderStream::flush_internal().

◆ flush_internal() [2/2]

virtual bool WvStreamClone::flush_internal ( time_t  msec_timeout)
virtualinherited

WvStream overrides.

These generally just call the cloned stream's version.

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, and WvEncoderStream.

◆ uread() [1/2]

size_t WvStreamClone::uread ( void *  buf,
size_t  count 
)
virtualinherited

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 WvSSLStream, WvSSLStream, WvEncoderStream, and WvEncoderStream.

Definition at line 107 of file wvstreamclone.cc.

References WvStreamClone::close(), and IWvStream::isok().

◆ uread() [2/2]

virtual size_t WvStreamClone::uread ( void *  buf,
size_t  count 
)
virtualinherited

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 WvSSLStream, WvSSLStream, WvEncoderStream, and WvEncoderStream.

◆ uwrite() [1/2]

size_t WvStreamClone::uwrite ( const void *  buf,
size_t  count 
)
virtualinherited

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 WvSSLStream, WvSSLStream, WvEncoderStream, WvEncoderStream, WvProtoStream, and WvProtoStream.

Definition at line 125 of file wvstreamclone.cc.

Referenced by WvProtoStream::uwrite().

◆ uwrite() [2/2]

virtual size_t WvStreamClone::uwrite ( const void *  buf,
size_t  count 
)
virtualinherited

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 WvSSLStream, WvSSLStream, WvEncoderStream, WvEncoderStream, WvProtoStream, and WvProtoStream.

◆ isok() [1/2]

bool WvStreamClone::isok ( ) const
virtualinherited

◆ isok() [2/2]

virtual bool WvStreamClone::isok ( ) const
virtualinherited

return true if the stream is actually usable right now

Reimplemented from WvStream.

Reimplemented in WvEncoderStream, WvSSLStream, WvEncoderStream, and WvSSLStream.

◆ geterr() [1/2]

int WvStreamClone::geterr ( ) const
virtualinherited

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 149 of file wvstreamclone.cc.

References WvErrorBase::geterr().

Referenced by WvHttpStream::close(), WvFtpStream::close(), WvStreamClone::isok(), WvDBusConn::~WvDBusConn(), and WvSSLStream::~WvSSLStream().

◆ geterr() [2/2]

virtual int WvStreamClone::geterr ( ) const
virtualinherited

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.

◆ errstr() [1/2]

WvString WvStreamClone::errstr ( ) const
virtualinherited

Reimplemented from WvErrorBase.

Definition at line 159 of file wvstreamclone.cc.

◆ errstr() [2/2]

virtual WvString WvStreamClone::errstr ( ) const
virtualinherited

Reimplemented from WvErrorBase.

◆ pre_select() [1/3]

void WvStreamClone::pre_select ( SelectInfo si)
virtualinherited

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, WvHttpStream, WvFtpStream, WvSSLStream, WvEncoderStream, WvHttpStream, WvFtpStream, and WvSSLStream.

Definition at line 199 of file wvstreamclone.cc.

References IWvStream::isok(), WvStream::pre_select(), and WvBufBaseCommonImpl< T >::used().

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

◆ pre_select() [2/3]

virtual void WvStreamClone::pre_select ( SelectInfo si)
virtualinherited

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, WvHttpStream, WvFtpStream, WvSSLStream, WvEncoderStream, WvHttpStream, WvFtpStream, and WvSSLStream.

◆ pre_select() [3/3]

void WvStream::pre_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

A more convenient version of pre_select() usable for overriding the 'want' value temporarily.

Definition at line 306 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::pre_select().

◆ post_select() [1/3]

bool WvStreamClone::post_select ( SelectInfo si)
virtualinherited

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, WvHttpStream, WvFtpStream, WvSSLStream, WvEncoderStream, WvHttpStream, WvFtpStream, and WvSSLStream.

Definition at line 222 of file wvstreamclone.cc.

References WvStream::flush(), IWvStream::isok(), WvStream::post_select(), WvStream::read_requires_writable, WvStream::select(), IWvStream::should_flush(), WvBufBaseCommonImpl< T >::used(), and WvStream::write_requires_readable.

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

◆ post_select() [2/3]

virtual bool WvStreamClone::post_select ( SelectInfo si)
virtualinherited

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, WvHttpStream, WvFtpStream, WvSSLStream, WvEncoderStream, WvHttpStream, WvFtpStream, and WvSSLStream.

◆ post_select() [3/3]

bool WvStream::post_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

A more convenient version of post_select() usable for overriding the 'want' value temporarily.

Definition at line 346 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::post_select().

◆ src() [1/2]

const WvAddr * WvStreamClone::src ( ) const
virtualinherited

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 264 of file wvstreamclone.cc.

◆ src() [2/2]

virtual const WvAddr * WvStreamClone::src ( ) const
virtualinherited

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.

◆ noread() [1/2]

void WvStreamClone::noread ( )
virtualinherited

Shuts down the reading side of the stream.

This is the opposite of nowrite(), but the name is actually slightly misleading; subsequent calls to read() might not fail; rather, if the other end of the connection tries to write to us, they should fail.

After noread(), if the read buffer (if any) is empty once, we promise that it will never refill.

If you call both noread() and nowrite(), then the stream does close() automatically once all buffers are empty.

Reimplemented from WvStream.

Reimplemented in WvSSLStream, and WvSSLStream.

Definition at line 61 of file wvstreamclone.cc.

References WvStream::noread(), and IWvStream::noread().

Referenced by WvSSLStream::noread(), and WvSSLStream::nowrite().

◆ noread() [2/2]

virtual void WvStreamClone::noread ( )
virtualinherited

Shuts down the reading side of the stream.

This is the opposite of nowrite(), but the name is actually slightly misleading; subsequent calls to read() might not fail; rather, if the other end of the connection tries to write to us, they should fail.

After noread(), if the read buffer (if any) is empty once, we promise that it will never refill.

If you call both noread() and nowrite(), then the stream does close() automatically once all buffers are empty.

Reimplemented from WvStream.

Reimplemented in WvSSLStream, and WvSSLStream.

◆ nowrite() [1/2]

void WvStreamClone::nowrite ( )
virtualinherited

Shuts down the writing side of the stream.

Subsequent calls to write() will fail. But if there's data in the output buffer, it will still be flushed.

If you call both noread() and nowrite(), then the stream does close() automatically once all buffers are empty.

Reimplemented from WvStream.

Reimplemented in WvSSLStream, and WvSSLStream.

Definition at line 72 of file wvstreamclone.cc.

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

Referenced by WvSSLStream::noread(), and WvSSLStream::nowrite().

◆ nowrite() [2/2]

virtual void WvStreamClone::nowrite ( )
virtualinherited

Shuts down the writing side of the stream.

Subsequent calls to write() will fail. But if there's data in the output buffer, it will still be flushed.

If you call both noread() and nowrite(), then the stream does close() automatically once all buffers are empty.

Reimplemented from WvStream.

Reimplemented in WvSSLStream, and WvSSLStream.

◆ getattr() [1/2]

WvString WvStreamClone::getattr ( WvStringParm  name) const
virtualinherited

Reimplemented from WvStream.

Definition at line 278 of file wvstreamclone.cc.

◆ getattr() [2/2]

virtual WvString WvStreamClone::getattr ( WvStringParm  name) const
virtualinherited

Reimplemented from WvStream.

◆ wstype() [1/2]

const char * WvStreamClone::wstype ( ) const
inlinevirtualinherited

Reimplemented from WvStream.

Definition at line 96 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstreamclone.h.

◆ wstype() [2/2]

const char * WvStreamClone::wstype ( ) const
inlinevirtualinherited

Reimplemented from WvStream.

Definition at line 96 of file include/wvstreamclone.h.

◆ seterr() [1/7]

void WvStream::seterr ( int  _errnum)
virtualinherited

◆ seterr() [2/7]

void WvStream::seterr ( WvStringParm  specialerr)
inlineinherited

◆ seterr() [3/7]

void WvStream::seterr ( WVSTRING_FORMAT_DECL  )
inlineinherited

◆ seterr() [4/7]

virtual void WvStream::seterr ( int  _errnum)
virtualinherited

Override seterr() from WvError so that it auto-closes the stream.

Reimplemented from WvErrorBase.

◆ seterr() [5/7]

void WvStream::seterr ( WvStringParm  specialerr)
inlineinherited

Definition at line 74 of file include/wvstream.h.

◆ seterr() [6/7]

void WvStream::seterr ( WVSTRING_FORMAT_DECL  )
inlineinherited

Definition at line 76 of file include/wvstream.h.

◆ seterr() [7/7]

void WvErrorBase::seterr ( const WvErrorBase err)
inherited

Definition at line 170 of file wverror.cc.

◆ read() [1/4]

size_t WvStream::read ( void *  buf,
size_t  count 
)
virtualinherited

◆ read() [2/4]

size_t WvStream::read ( WvBuf &  outbuf,
size_t  count 
)
virtualinherited

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.

Implements IWvStream.

Definition at line 461 of file wvstream.cc.

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

◆ read() [3/4]

virtual size_t WvStream::read ( void *  buf,
size_t  count 
)
virtualinherited

read a data block on the stream.

Returns the actual amount read.

Implements IWvStream.

◆ read() [4/4]

virtual size_t WvStream::read ( WvBuf &  outbuf,
size_t  count 
)
virtualinherited

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.

Implements IWvStream.

◆ unread() [1/2]

void WvStream::unread ( WvBuf &  outbuf,
size_t  count 
)
virtualinherited

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 1190 of file wvstream.cc.

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

Referenced by WvHttpStream::execute().

◆ unread() [2/2]

virtual void WvStream::unread ( WvBuf &  outbuf,
size_t  count 
)
virtualinherited

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).

◆ write() [1/6]

size_t WvStream::write ( const void *  buf,
size_t  count 
)
virtualinherited

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).

Implements IWvStream.

Definition at line 532 of file wvstream.cc.

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

Referenced by WvLogFileBase::_mid_line(), WvDBusClientAuth::authorize(), WvModem::close(), WvHttpStream::execute(), WvIStreamList::execute(), WvModemBase::hangup(), WvLog::operator()(), WvStream::print(), WvDBusConn::send(), UniFileSystemGen::set(), WvFdStream::uwrite(), WvProtoStream::uwrite(), WvStream::write(), WvStream::write(), and UniClientConn::writecmd().

◆ write() [2/6]

size_t WvStream::write ( WvBuf &  inbuf,
size_t  count = INT_MAX 
)
virtualinherited

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.

Implements IWvStream.

Definition at line 477 of file wvstream.cc.

References WvStream::write().

◆ write() [3/6]

size_t WvStream::write ( WvStringParm  s)
inlineinherited

print a preformatted WvString to the stream.

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

Definition at line 538 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

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

◆ write() [4/6]

virtual size_t WvStream::write ( const void *  buf,
size_t  count 
)
virtualinherited

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).

Implements IWvStream.

◆ write() [5/6]

virtual size_t WvStream::write ( WvBuf &  inbuf,
size_t  count = INT_MAX 
)
virtualinherited

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.

Implements IWvStream.

◆ write() [6/6]

size_t WvStream::write ( WvStringParm  s)
inlineinherited

print a preformatted WvString to the stream.

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

Definition at line 538 of file include/wvstream.h.

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

◆ outbuf_limit() [1/2]

void WvStream::outbuf_limit ( size_t  size)
inlinevirtualinherited

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?

Implements IWvStream.

Definition at line 129 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

◆ outbuf_limit() [2/2]

void WvStream::outbuf_limit ( size_t  size)
inlinevirtualinherited

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?

Implements IWvStream.

Definition at line 129 of file include/wvstream.h.

◆ maybe_autoclose() [1/2]

void WvStream::maybe_autoclose ( )
virtualinherited

Auto-close the stream if the time is right.

If noread() and nowrite() and all buffers are empty, then we can probably close.

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

Definition at line 583 of file wvstream.cc.

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

Referenced by WvStream::blocking_getline(), WvFdStream::maybe_autoclose(), WvStream::noread(), WvStream::nowrite(), WvStream::pre_select(), and WvStream::read().

◆ maybe_autoclose() [2/2]

virtual void WvStream::maybe_autoclose ( )
virtualinherited

Auto-close the stream if the time is right.

If noread() and nowrite() and all buffers are empty, then we can probably close.

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

◆ isreadable() [1/2]

bool WvStream::isreadable ( )
virtualinherited

Returns true if the stream is readable.

Implements IWvStream.

Definition at line 590 of file wvstream.cc.

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

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

◆ isreadable() [2/2]

virtual bool WvStream::isreadable ( )
virtualinherited

Returns true if the stream is readable.

Implements IWvStream.

◆ iswritable() [1/2]

bool WvStream::iswritable ( )
virtualinherited

Returns true if the stream is writable (without using the outbuf).

Implements IWvStream.

Definition at line 596 of file wvstream.cc.

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

◆ iswritable() [2/2]

virtual bool WvStream::iswritable ( )
virtualinherited

Returns true if the stream is writable (without using the outbuf).

Implements IWvStream.

◆ getline() [1/6]

char * WvStream::getline ( time_t  wait_msec = 0,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::blocking_getline().

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

◆ getline() [2/6]

char * WvStream::getline ( int  wait_msec,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

Auto-convert int to time_t.

Definition at line 182 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::getline().

◆ getline() [3/6]

char * WvStream::getline ( double  wait_msec,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

Auto-convert double to time_t.

Definition at line 189 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::getline().

◆ getline() [4/6]

char * WvStream::getline ( time_t  wait_msec = 0,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

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 include/wvstream.h.

References WvStream::blocking_getline().

◆ getline() [5/6]

char * WvStream::getline ( int  wait_msec,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

Auto-convert int to time_t.

Definition at line 182 of file include/wvstream.h.

References WvStream::getline().

◆ getline() [6/6]

char * WvStream::getline ( double  wait_msec,
char  separator = '\n',
int  readahead = 1024 
)
inlineinherited

Auto-convert double to time_t.

Definition at line 189 of file include/wvstream.h.

References WvStream::getline().

◆ blocking_getline() [1/2]

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 602 of file wvstream.cc.

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

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

◆ blocking_getline() [2/2]

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().

◆ continue_getline()

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

This is a version of blocking_getline() that uses continue_select to avoid blocking other streams.

Definition at line 690 of file wvstream.cc.

References WvStream::uses_continue_select.

◆ queuemin() [1/2]

void WvStream::queuemin ( size_t  count)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

Referenced by WvStream::blocking_getline().

◆ queuemin() [2/2]

void WvStream::queuemin ( size_t  count)
inlineinherited

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 include/wvstream.h.

◆ drain()

void WvStream::drain ( )
inherited

drain the input buffer (read and discard data until select(0) returns false)

Definition at line 699 of file wvstream.cc.

References WvStream::isreadable(), and WvStream::read().

Referenced by WvModem::close(), WvModemBase::hangup(), and WvMagicLoopback::pre_select().

◆ delay_output() [1/2]

void WvStream::delay_output ( bool  is_delayed)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

◆ delay_output() [2/2]

void WvStream::delay_output ( bool  is_delayed)
inlineinherited

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 include/wvstream.h.

◆ auto_flush() [1/2]

void WvStream::auto_flush ( bool  is_automatic)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

◆ auto_flush() [2/2]

void WvStream::auto_flush ( bool  is_automatic)
inlineinherited

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 include/wvstream.h.

◆ flush() [1/2]

bool WvStream::flush ( time_t  msec_timeout)
virtualinherited

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).

Implements IWvStream.

Definition at line 707 of file wvstream.cc.

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

◆ flush() [2/2]

virtual bool WvStream::flush ( time_t  msec_timeout)
virtualinherited

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).

Implements IWvStream.

◆ should_flush() [1/2]

bool WvStream::should_flush ( )
virtualinherited

Returns true if we want to flush the output buffer right now.

This allows us to implement delayed_flush(), flush_then_close(), etc, but it's still super-ugly and probably needs to go away. (In fact, all our buffer flushing is super-ugly right now.)

Implements IWvStream.

Definition at line 724 of file wvstream.cc.

Referenced by WvFdStream::post_select(), WvStream::post_select(), and WvStream::write().

◆ should_flush() [2/2]

virtual bool WvStream::should_flush ( )
virtualinherited

Returns true if we want to flush the output buffer right now.

This allows us to implement delayed_flush(), flush_then_close(), etc, but it's still super-ugly and probably needs to go away. (In fact, all our buffer flushing is super-ugly right now.)

Implements IWvStream.

◆ flush_then_close() [1/2]

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 827 of file wvstream.cc.

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

◆ flush_then_close() [2/2]

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)

◆ xpre_select() [1/2]

void WvStream::xpre_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

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

Sigh.

Definition at line 318 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::pre_select().

Referenced by WvResolver::pre_select().

◆ xpre_select() [2/2]

void WvStream::xpre_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

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

Sigh.

Definition at line 318 of file include/wvstream.h.

References WvStream::pre_select().

◆ xpost_select() [1/2]

bool WvStream::xpost_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

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

Sigh.

Definition at line 339 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::post_select().

Referenced by WvResolver::post_select().

◆ xpost_select() [2/2]

bool WvStream::xpost_select ( SelectInfo si,
const SelectRequest r 
)
inlineinherited

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

Sigh.

Definition at line 339 of file include/wvstream.h.

References WvStream::post_select().

◆ select() [1/4]

bool WvStream::select ( time_t  msec_timeout)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

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

◆ select() [2/4]

bool WvStream::select ( time_t  msec_timeout,
bool  readable,
bool  writable,
bool  isex = false 
)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

◆ select() [3/4]

bool WvStream::select ( time_t  msec_timeout)
inlineinherited

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 include/wvstream.h.

◆ select() [4/4]

bool WvStream::select ( time_t  msec_timeout,
bool  readable,
bool  writable,
bool  isex = false 
)
inlineinherited

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 include/wvstream.h.

◆ runonce() [1/2]

void WvStream::runonce ( time_t  msec_timeout = -1)
inlineinherited

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 debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

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

Referenced by WvDBusConn::send_and_wait().

◆ runonce() [2/2]

void WvStream::runonce ( time_t  msec_timeout = -1)
inlineinherited

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 include/wvstream.h.

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

◆ get_select_request() [1/2]

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 1020 of file wvstream.cc.

◆ get_select_request() [2/2]

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.

◆ force_select() [1/2]

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 1027 of file wvstream.cc.

Referenced by WvStreamClone::WvStreamClone().

◆ force_select() [2/2]

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().)

◆ undo_force_select() [1/2]

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 1038 of file wvstream.cc.

◆ undo_force_select() [2/2]

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.

◆ continue_select() [1/2]

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 1089 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().

◆ continue_select() [2/2]

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().

◆ terminate_continue_select()

void WvStream::terminate_continue_select ( )
inherited

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().

Definition at line 1116 of file wvstream.cc.

References WvStream::close().

◆ setcallback()

void WvStream::setcallback ( IWvStreamCallback  _callfunc)
inherited

define the callback function for this stream, called whenever the callback() member is run, and passed the 'userdata' pointer.

Definition at line 1129 of file wvstream.cc.

Referenced by WvStream::autoforward(), WvStream::noautoforward(), and UniClientGen::UniClientGen().

◆ setreadcallback() [1/2]

IWvStreamCallback WvStream::setreadcallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

Definition at line 1144 of file wvstream.cc.

References WvStream::_callback().

◆ setreadcallback() [2/2]

IWvStreamCallback WvStream::setreadcallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

◆ setwritecallback() [1/2]

IWvStreamCallback WvStream::setwritecallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

Definition at line 1154 of file wvstream.cc.

References WvStream::_callback().

◆ setwritecallback() [2/2]

IWvStreamCallback WvStream::setwritecallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

◆ setexceptcallback() [1/2]

IWvStreamCallback WvStream::setexceptcallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

Definition at line 1164 of file wvstream.cc.

References WvStream::_callback().

◆ setexceptcallback() [2/2]

IWvStreamCallback WvStream::setexceptcallback ( IWvStreamCallback  _callback)
virtualinherited

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

Implements IWvStream.

◆ setclosecallback() [1/2]

IWvStreamCallback WvStream::setclosecallback ( IWvStreamCallback  _callback)
virtualinherited

Sets a callback to be invoked on close().


Implements IWvStream.

Definition at line 1174 of file wvstream.cc.

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

◆ setclosecallback() [2/2]

IWvStreamCallback WvStream::setclosecallback ( IWvStreamCallback  _callback)
virtualinherited

Sets a callback to be invoked on close().


Implements IWvStream.

◆ autoforward()

void WvStream::autoforward ( WvStream s)
inherited

set the callback function for this stream to an internal routine that auto-forwards all incoming stream data to the given output stream.

Definition at line 362 of file wvstream.cc.

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

◆ noautoforward()

void WvStream::noautoforward ( )
inherited

Stops autoforwarding.

Definition at line 369 of file wvstream.cc.

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

◆ autoforward_callback()

void WvStream::autoforward_callback ( WvStream input,
WvStream output 
)
staticinherited

Definition at line 376 of file wvstream.cc.

◆ _callwrap()

void * WvStream::_callwrap ( void *  )
inherited

A wrapper that's compatible with WvCont, but calls the "real" callback.

Definition at line 394 of file wvstream.cc.

References WvStream::_callback().

Referenced by WvStream::callback().

◆ _callback()

void WvStream::_callback ( )
inherited

◆ callback() [1/2]

void WvStream::callback ( )
virtualinherited

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

otherwise call execute().

Implements IWvStream.

Definition at line 401 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().

◆ callback() [2/2]

virtual void WvStream::callback ( )
virtualinherited

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

otherwise call execute().

Implements IWvStream.

◆ alarm() [1/2]

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 1049 of file wvstream.cc.

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

◆ alarm() [2/2]

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.

◆ alarm_remaining()

time_t WvStream::alarm_remaining ( )
inherited

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().

Definition at line 1058 of file wvstream.cc.

Referenced by WvStream::callback(), WvIStreamList::post_select(), WvStream::post_select(), WvIStreamList::pre_select(), WvStream::pre_select(), and WvUnixDGSocket::pre_select().

◆ print() [1/4]

size_t WvStream::print ( WvStringParm  s)
inlineinherited

◆ print() [2/4]

size_t WvStream::print ( WVSTRING_FORMAT_DECL  )
inlineinherited

preformat and write() a string.

Definition at line 546 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

References WvStream::write().

◆ print() [3/4]

size_t WvStream::print ( WvStringParm  s)
inlineinherited

Definition at line 540 of file include/wvstream.h.

◆ print() [4/4]

size_t WvStream::print ( WVSTRING_FORMAT_DECL  )
inlineinherited

preformat and write() a string.

Definition at line 546 of file include/wvstream.h.

References WvStream::write().

◆ operator()() [1/4]

size_t WvStream::operator() ( WvStringParm  s)
inlineinherited

◆ operator()() [2/4]

size_t WvStream::operator() ( WVSTRING_FORMAT_DECL  )
inlineinherited

◆ operator()() [3/4]

size_t WvStream::operator() ( WvStringParm  s)
inlineinherited

Definition at line 542 of file include/wvstream.h.

◆ operator()() [4/4]

size_t WvStream::operator() ( WVSTRING_FORMAT_DECL  )
inlineinherited

Definition at line 548 of file include/wvstream.h.

◆ wsname() [1/2]

const char * WvStream::wsname ( ) const
inlinevirtualinherited

◆ wsname() [2/2]

const char * WvStream::wsname ( ) const
inlinevirtualinherited

Implements IWvStream.

Definition at line 551 of file include/wvstream.h.

◆ set_wsname() [1/4]

void WvStream::set_wsname ( WvStringParm  wsname)
inlinevirtualinherited

◆ set_wsname() [2/4]

void WvStream::set_wsname ( WVSTRING_FORMAT_DECL  )
inlineinherited

◆ set_wsname() [3/4]

void WvStream::set_wsname ( WvStringParm  wsname)
inlinevirtualinherited

Implements IWvStream.

Definition at line 553 of file include/wvstream.h.

◆ set_wsname() [4/4]

void WvStream::set_wsname ( WVSTRING_FORMAT_DECL  )
inlineinherited

Definition at line 555 of file include/wvstream.h.

◆ wsid() [1/2]

WSID WvStream::wsid ( ) const
inlinevirtualinherited

◆ wsid() [2/2]

WSID WvStream::wsid ( ) const
inlinevirtualinherited

Implements IWvStream.

Definition at line 560 of file include/wvstream.h.

◆ find_by_wsid()

IWvStream * WvStream::find_by_wsid ( WSID  wsid)
staticinherited

Definition at line 1200 of file wvstream.cc.

◆ setattr() [1/2]

void WvStream::setattr ( WvStringParm  name,
WvStringParm  value 
)
inlineprotectedinherited

◆ setattr() [2/2]

void WvStream::setattr ( WvStringParm  name,
WvStringParm  value 
)
inlineprotectedinherited

Definition at line 580 of file include/wvstream.h.

◆ _build_selectinfo()

void WvStream::_build_selectinfo ( SelectInfo si,
time_t  msec_timeout,
bool  readable,
bool  writable,
bool  isexcept,
bool  forceable 
)
protectedinherited

Definition at line 901 of file wvstream.cc.

◆ _do_select()

int WvStream::_do_select ( SelectInfo si)
protectedinherited

Definition at line 939 of file wvstream.cc.

◆ _process_selectinfo()

bool WvStream::_process_selectinfo ( SelectInfo si,
bool  forceable 
)
protectedinherited

Definition at line 977 of file wvstream.cc.

◆ flush_outbuf()

bool WvStream::flush_outbuf ( time_t  msec_timeout)
protectedinherited

Definition at line 730 of file wvstream.cc.

◆ getrfd() [1/2]

int WvStream::getrfd ( ) const
protectedvirtualinherited

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

Definition at line 815 of file wvstream.cc.

◆ getrfd() [2/2]

virtual int WvStream::getrfd ( ) const
protectedvirtualinherited

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

◆ getwfd() [1/2]

int WvStream::getwfd ( ) const
protectedvirtualinherited

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

Definition at line 821 of file wvstream.cc.

◆ getwfd() [2/2]

virtual int WvStream::getwfd ( ) const
protectedvirtualinherited

Implements IWvStream.

Reimplemented in WvFdStream, and WvFdStream.

◆ debugger_streams_display_header()

void WvStream::debugger_streams_display_header ( WvStringParm  cmd,
WvStreamsDebugger::ResultCallback  result_cb 
)
staticprotectedinherited

Definition at line 125 of file wvstream.cc.

◆ debugger_streams_display_one_stream()

void WvStream::debugger_streams_display_one_stream ( WvStream s,
WvStringParm  cmd,
WvStreamsDebugger::ResultCallback  result_cb 
)
staticprotectedinherited

Definition at line 152 of file wvstream.cc.

◆ debugger_streams_maybe_display_one_stream()

void WvStream::debugger_streams_maybe_display_one_stream ( WvStream s,
WvStringParm  cmd,
const WvStringList args,
WvStreamsDebugger::ResultCallback  result_cb 
)
staticprotectedinherited

Definition at line 171 of file wvstream.cc.

◆ create()

IWvStream * IWvStream::create ( WvStringParm  moniker,
IObject obj = NULL 
)
staticinherited

Definition at line 80 of file wvstream.cc.

◆ strerror()

WvString WvErrorBase::strerror ( int  errnum)
staticinherited

A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).

Definition at line 91 of file wverror.cc.

References WvErrorBase::strerror().

Referenced by WvLog::perror(), WvErrorBase::strerror(), WvSSLStream::uread(), and WvSSLStream::uwrite().

◆ seterr_both() [1/3]

void WvErrorBase::seterr_both ( int  _errnum,
WvStringParm  specialerr 
)
inherited

Definition at line 179 of file wverror.cc.

◆ seterr_both() [2/3]

void WvErrorBase::seterr_both ( int  _errnum,
WVSTRING_FORMAT_DECL   
)
inlineinherited

◆ seterr_both() [3/3]

void WvErrorBase::seterr_both ( int  _errnum,
WVSTRING_FORMAT_DECL   
)
inlineinherited

Definition at line 73 of file include/wverror.h.

◆ noerr() [1/2]

void WvErrorBase::noerr ( )
inlineinherited

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

Definition at line 78 of file debian/libwvstreams-dev/usr/include/wvstreams/wverror.h.

◆ noerr() [2/2]

void WvErrorBase::noerr ( )
inlineinherited

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

Definition at line 78 of file include/wverror.h.

◆ addRef() [1/2]

virtual unsigned int IObject::addRef ( )
pure virtualinherited

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 WvIStreamList::execute(), IObjectImplInternal::getInterface(), WeakRef::getObject(), StaticServiceHandler::getObject(), WvIStreamList::post_select(), WvQtStreamClone::WvQtStreamClone(), and WvSSLStream::WvSSLStream().

◆ addRef() [2/2]

virtual unsigned int IObject::addRef ( )
pure virtualinherited

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.

◆ release() [1/2]

virtual unsigned int IObject::release ( )
pure virtualinherited

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 WvIStreamList::execute(), mutate(), MonikerService::resolve(), and NewMoniker::resolve().

◆ release() [2/2]

virtual unsigned int IObject::release ( )
pure virtualinherited

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.

◆ getInterface() [1/2]

virtual IObject * IObject::getInterface ( const UUID )
pure virtualinherited

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 get(), and mutate().

◆ getInterface() [2/2]

virtual IObject * IObject::getInterface ( const UUID )
pure virtualinherited

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.

◆ getWeakRef() [1/2]

virtual IWeakRef * IObject::getWeakRef ( )
pure virtualinherited

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

◆ getWeakRef() [2/2]

virtual IWeakRef * IObject::getWeakRef ( )
pure virtualinherited

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

◆ root

UniConf UniConfDaemonConn::root
protected

◆ log

WvLog UniClientConn::log
protectedinherited

◆ closed

bool UniClientConn::closed
protectedinherited

◆ version

int UniClientConn::version
protectedinherited

◆ payloadbuf

WvConstStringBuffer UniClientConn::payloadbuf
inherited

holds the previous command payload

Definition at line 37 of file debian/libwvstreams-dev/usr/include/wvstreams/uniclientconn.h.

Referenced by UniClientConn::readarg().

◆ NUM_COMMANDS

static const int UniClientConn::NUM_COMMANDS = EVENT_NOTICE + 1
staticinherited

◆ cmdinfos

const UniClientConn::CommandInfo UniClientConn::cmdinfos
staticinherited
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 24 of file debian/libwvstreams-dev/usr/include/wvstreams/uniclientconn.h.

◆ cloned

IWvStream * WvStreamClone::cloned
inherited

◆ my_type

WvString WvStreamClone::my_type
protectedinherited

◆ read_requires_writable

WvStream * WvStream::read_requires_writable
inherited

If this is set, select() doesn't return true for read unless the given stream also returns true for write.

Definition at line 36 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

Referenced by WvStream::autoforward(), WvStream::noautoforward(), WvFdStream::post_select(), and WvStreamClone::post_select().

◆ write_requires_readable

WvStream * WvStream::write_requires_readable
inherited

If this is set, select() doesn't return true for write unless the given stream also returns true for read.

Definition at line 42 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

Referenced by WvFdStream::post_select(), and WvStreamClone::post_select().

◆ uses_continue_select

bool WvStream::uses_continue_select
inherited

◆ personal_stack_size

size_t WvStream::personal_stack_size
inherited

Specifies the stack size to reserve for continue_select().

Definition at line 48 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

Referenced by WvStream::callback().

◆ alarm_was_ticking

bool WvStream::alarm_was_ticking
inherited

This will be true during callback execution if the callback was triggered by the alarm going off.

Definition at line 54 of file debian/libwvstreams-dev/usr/include/wvstreams/wvstream.h.

Referenced by WvStream::callback(), WvStream::continue_select(), WvHttpStream::execute(), WvTimeoutStream::execute(), and WvTimeStream::execute().

◆ stop_read

bool WvStream::stop_read
inherited

◆ stop_write

bool WvStream::stop_write
inherited

◆ inbuf

WvDynBuf WvStream::inbuf
protectedinherited

◆ outbuf

WvDynBuf WvStream::outbuf
protectedinherited

◆ callfunc

IWvStreamCallback WvStream::callfunc
protectedinherited

◆ call_ctx

wv::function< void *(void *)> WvStream::call_ctx
protectedinherited

◆ readcb

IWvStreamCallback WvStream::readcb
protectedinherited

◆ writecb

IWvStreamCallback WvStream::writecb
protectedinherited

◆ exceptcb

IWvStreamCallback WvStream::exceptcb
protectedinherited

◆ closecb

IWvStreamCallback WvStream::closecb
protectedinherited

◆ max_outbuf_size

size_t WvStream::max_outbuf_size
protectedinherited

◆ outbuf_delayed_flush

bool WvStream::outbuf_delayed_flush
protectedinherited

◆ is_auto_flush

bool WvStream::is_auto_flush
protectedinherited

◆ want_to_flush

bool WvStream::want_to_flush
protectedinherited

◆ is_flushing

bool WvStream::is_flushing
protectedinherited

◆ queue_min

size_t WvStream::queue_min
protectedinherited

◆ autoclose_time

time_t WvStream::autoclose_time
protectedinherited

◆ alarm_time

WvTime WvStream::alarm_time
protectedinherited

◆ last_alarm_check

WvTime WvStream::last_alarm_check
protectedinherited

◆ globalstream

WvStream * WvStream::globalstream = NULL
staticprotectedinherited

◆ errnum

int WvErrorBase::errnum
protectedinherited

◆ errstring

WvString WvErrorBase::errstring
protectedinherited

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