WvStreams
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes
IWvStream Class Reference
Inheritance diagram for IWvStream:
Inheritance graph
[legend]

List of all members.

Classes

struct  SelectInfo
 the data structure used by pre_select()/post_select() and internally by select(). More...
struct  SelectRequest
 A SelectRequest is a convenient way to remember what we want to do to a particular stream: read from it, write to it, or check for exceptions. More...

Public Member Functions

virtual void close ()=0
virtual bool isok () const =0
 By default, returns true if geterr() == 0.
virtual void callback ()=0
virtual int getrfd () const =0
virtual int getwfd () const =0
virtual const WvAddrsrc () const =0
virtual void pre_select (SelectInfo &si)=0
virtual bool post_select (SelectInfo &si)=0
virtual size_t read (void *buf, size_t count)=0
virtual size_t write (const void *buf, size_t count)=0
virtual size_t read (WvBuf &outbuf, size_t count)=0
virtual size_t write (WvBuf &inbuf, size_t count=INT_MAX)=0
virtual void noread ()=0
 Shuts down the reading side of the stream.
virtual void nowrite ()=0
 Shuts down the writing side of the stream.
virtual void maybe_autoclose ()=0
 Auto-close the stream if the time is right.
virtual bool isreadable ()=0
 Returns true if the stream is readable.
virtual bool iswritable ()=0
 Returns true if the stream is writable (without using the outbuf).
virtual bool flush (time_t msec_timeout)=0
 flush the output buffer, if we can do it without delaying more than msec_timeout milliseconds at a time.
virtual bool should_flush ()=0
 Returns true if we want to flush the output buffer right now.
virtual IWvStreamCallback setreadcallback (IWvStreamCallback _callfunc)=0
 Sets a callback to be invoked when the stream is readable.
virtual IWvStreamCallback setwritecallback (IWvStreamCallback _callfunc)=0
 Sets a callback to be invoked when the stream is writable.
virtual IWvStreamCallback setexceptcallback (IWvStreamCallback _callfunc)=0
 Sets a callback to be invoked when the stream is in exception state.
virtual IWvStreamCallback setclosecallback (IWvStreamCallback _callfunc)=0
 Sets a callback to be invoked on close().
virtual const char * wsname () const =0
virtual void set_wsname (WvStringParm name)=0
virtual const char * wstype () const =0
virtual WSID wsid () const =0
virtual void outbuf_limit (size_t size)=0
 set the maximum size of outbuf, beyond which a call to write() will return 0.
virtual WvString getattr (WvStringParm name) const =0
virtual int geterr () const
 If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.
virtual WvString errstr () const
virtual void seterr (int _errnum)
 Set the errnum variable -- we have an error.
void seterr (WvStringParm specialerr)
void seterr (WVSTRING_FORMAT_DECL)
void seterr (const WvErrorBase &err)
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.
virtual unsigned int addRef ()=0
 Indicate you are using this object.
virtual unsigned int release ()=0
 Indicate that you are finished using this object.
virtual IObjectgetInterface (const UUID &)=0
 Returns the requested XPLC interface.
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.

Static Public Member Functions

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

Protected Attributes

int errnum
WvString errstring

Detailed Description

Definition at line 24 of file iwvstream.h.


Member Function Documentation

virtual bool IWvStream::isok ( ) const [pure virtual]
virtual void IWvStream::noread ( ) [pure virtual]

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.

Implemented in WvStream, WvStreamClone, WvListener, and WvSSLStream.

Referenced by WvStreamClone::noread().

virtual void IWvStream::nowrite ( ) [pure virtual]

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.

Implemented in WvStream, WvStreamClone, WvListener, and WvSSLStream.

Referenced by WvStreamClone::flush_internal(), and WvStreamClone::nowrite().

virtual void IWvStream::maybe_autoclose ( ) [pure virtual]

Auto-close the stream if the time is right.

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

Implemented in WvStream, WvFdStream, and WvListener.

virtual bool IWvStream::isreadable ( ) [pure virtual]

Returns true if the stream is readable.

Implemented in WvStream, and WvListener.

Referenced by WvSSLStream::post_select().

virtual bool IWvStream::iswritable ( ) [pure virtual]

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

Implemented in WvStream, and WvListener.

Referenced by WvSSLStream::post_select().

virtual bool IWvStream::flush ( time_t  msec_timeout) [pure virtual]

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 it finished flushing (ie. the outbuf is empty).

FIXME: Something like this probably belongs in IWvStream, but probably not exactly this.

Implemented in WvStream, and WvListener.

Referenced by WvStreamClone::flush_internal().

virtual bool IWvStream::should_flush ( ) [pure virtual]

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

Implemented in WvStream, and WvListener.

Referenced by WvStreamClone::post_select().

virtual IWvStreamCallback IWvStream::setreadcallback ( IWvStreamCallback  _callfunc) [pure virtual]

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

Implemented in WvStream, and WvListener.

virtual IWvStreamCallback IWvStream::setwritecallback ( IWvStreamCallback  _callfunc) [pure virtual]

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

Implemented in WvStream, and WvListener.

virtual IWvStreamCallback IWvStream::setexceptcallback ( IWvStreamCallback  _callfunc) [pure virtual]

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

Implemented in WvStream, and WvListener.

virtual IWvStreamCallback IWvStream::setclosecallback ( IWvStreamCallback  _callfunc) [pure virtual]

Sets a callback to be invoked on close().

Implemented in WvStream, and WvListener.

Referenced by WvStreamsDaemon::add_die_stream(), WvStreamsDaemon::add_restart_stream(), WvStreamClone::close(), and WvStreamClone::setclone().

virtual int WvErrorBase::geterr ( ) const [inline, virtual, inherited]

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

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

Reimplemented in WvStreamClone, and WvDBusServer.

Definition at line 48 of file wverror.h.

Referenced by UniIniGen::commit(), UniFileSystemGen::get(), WvStreamClone::geterr(), WvEncoderStream::isok(), UniConfDaemon::listen(), UniIniGen::refresh(), WvStream::seterr(), and WvMagicCircle::WvMagicCircle().

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

Set the errnum variable -- we have an error.

If called more than once, seterr() doesn't change the error code away from the previous one. That way, we remember the _original_ cause of our problems.

Subclasses may want to override seterr(int) to shut themselves down (eg. WvStream::close()) when an error condition is set.

Note that seterr(WvString) will call seterr(-1).

Reimplemented in WvStream.

Definition at line 144 of file wverror.cc.

Referenced by WvUnixListener::accept(), WvTCPListener::accept(), WvDSAKey::getpem(), WvGlob::set(), WvMagicCircle::WvMagicCircle(), WvPam::WvPam(), WvShmZone::WvShmZone(), and WvTCPListener::WvTCPListener().

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

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

Definition at line 78 of file wverror.h.

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

Indicate you are using this object.

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

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

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

Referenced by WvIStreamList::execute(), IObjectImplInternal::getInterface(), StaticServiceHandler::getObject(), WeakRef::getObject(), WvIStreamList::post_select(), WvQtStreamClone::WvQtStreamClone(), and WvSSLStream::WvSSLStream().

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

Indicate that you are finished using this object.

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

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

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

Referenced by WvIStreamList::execute(), mutate(), NewMoniker::resolve(), and MonikerService::resolve().

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

Returns the requested XPLC interface.

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

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

Referenced by mutate().

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

Return a weak reference to this object.

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

See also:
IWeakRef

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