WvStreams
|
Server end of a Unix Sockets stream. More...
#include <wvunixlistener.h>
Public Member Functions | |
WvUnixListener (const WvUnixAddr &_addr, int create_mode) | |
virtual void | close () |
IWvStream * | accept () |
return a new WvUnixConn socket corresponding to a newly-accepted connection. More... | |
virtual const WvUnixAddr * | src () const |
src() is a bit of a misnomer, but it returns the socket address. | |
const char * | wstype () const |
virtual void | addwrap (IWvListenerWrapper _wrapper) |
Add a wrapper function for this stream: something that accept() will call to possibly wrap the stream from accept() before returning it. More... | |
virtual IWvListenerCallback | onaccept (IWvListenerCallback _cb) |
Set a user-defined function to be called when a new connection is available. More... | |
IWvStream * | wrap (IWvStream *s) |
void | runonce (time_t msec_delay) |
virtual bool | isok () const |
By default, returns true if geterr() == 0. More... | |
virtual void | callback () |
int | getfd () const |
virtual int | getrfd () const |
virtual int | getwfd () const |
virtual void | pre_select (SelectInfo &si) |
virtual bool | post_select (SelectInfo &si) |
virtual size_t | read (void *buf, size_t count) |
virtual size_t | read (WvBuf &outbuf, size_t count) |
virtual size_t | write (const void *buf, size_t count) |
virtual size_t | write (WvBuf &inbuf, size_t count=INT_MAX) |
virtual void | noread () |
Shuts down the reading side of the stream. More... | |
virtual void | nowrite () |
Shuts down the writing side of the stream. More... | |
virtual void | maybe_autoclose () |
Auto-close the stream if the time is right. More... | |
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 | flush (time_t msec_timeout) |
flush the output buffer, if we can do it without delaying more than msec_timeout milliseconds at a time. More... | |
virtual bool | should_flush () |
Returns true if we want to flush the output buffer right now. More... | |
virtual IWvStreamCallback | setreadcallback (IWvStreamCallback _cb) |
Sets a callback to be invoked when the stream is readable. | |
virtual IWvStreamCallback | setwritecallback (IWvStreamCallback _cb) |
Sets a callback to be invoked when the stream is writable. | |
virtual IWvStreamCallback | setexceptcallback (IWvStreamCallback _cb) |
Sets a callback to be invoked when the stream is in exception state. | |
virtual IWvStreamCallback | setclosecallback (IWvStreamCallback _cb) |
Sets a callback to be invoked on close(). More... | |
virtual const char * | wsname () const |
virtual void | set_wsname (WvStringParm name) |
void | set_wsname (WVSTRING_FORMAT_DECL) |
virtual WSID | wsid () const |
virtual void | outbuf_limit (size_t size) |
set the maximum size of outbuf, beyond which a call to write() will return 0. More... | |
virtual WvString | getattr (WvStringParm name) const |
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. More... | |
virtual WvString | errstr () const |
virtual void | seterr (int _errnum) |
Set the errnum variable – we have an error. More... | |
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. More... | |
virtual unsigned int | release ()=0 |
Indicate that you are finished using this object. More... | |
virtual IObject * | getInterface (const UUID &)=0 |
Returns the requested XPLC interface. More... | |
virtual IWeakRef * | getWeakRef ()=0 |
Return a weak reference to this object. More... | |
Static Public Member Functions | |
static IWvListener * | create (WvString moniker, IObject *obj=NULL) |
static IWvStream * | create (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). | |
Public Attributes | |
IWvStream * | cloned |
IWvListenerCallback | acceptor |
IWvListenerWrapper | wrapper |
Protected Member Functions | |
void | accept_callback (WvIStreamList *list, wv::function< void(IWvStream *)> cb, IWvStream *_connection) |
Protected Attributes | |
WvUnixAddr | addr |
bool | bound_okay |
int | errnum |
WvString | errstring |
Server end of a Unix Sockets stream.
Definition at line 15 of file wvunixlistener.h.
|
virtual |
return a new WvUnixConn socket corresponding to a newly-accepted connection.
If no connection is ready immediately, we wait for one indefinitely. You can use select(read=true) to check for a waiting connection.
Implements IWvListener.
Definition at line 214 of file wvunixsocket.cc.
References WvListener::isok(), and WvErrorBase::seterr().
|
virtualinherited |
Add a wrapper function for this stream: something that accept() will call to possibly wrap the stream from accept() before returning it.
You can use this more than once; the wrappers will be called in order (so the "innermost" stream is the original, the first wrapper is next, and so on).
Implements IWvListener.
Definition at line 54 of file wvlistener.cc.
|
virtualinherited |
Set a user-defined function to be called when a new connection is available.
The new connection IWvStream is given, and it's the callback's responsibility to make sure it gets freed properly.
Implements IWvListener.
Definition at line 87 of file wvlistener.cc.
|
inlinevirtualinherited |
By default, returns true if geterr() == 0.
Might be overridden so that isok() == false even though no error code has been specified.
Implements IWvStream.
Reimplemented in WvNullListener.
Definition at line 38 of file wvlistener.h.
References WvErrorBase::isok(), and IWvStream::isok().
Referenced by accept(), and WvTCPListener::accept().
|
inlinevirtualinherited |
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.
Implements IWvStream.
Definition at line 66 of file wvlistener.h.
|
inlinevirtualinherited |
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.
Implements IWvStream.
Definition at line 68 of file wvlistener.h.
|
inlinevirtualinherited |
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.
Definition at line 70 of file wvlistener.h.
|
inlinevirtualinherited |
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.
Implements IWvStream.
Definition at line 76 of file wvlistener.h.
|
inlinevirtualinherited |
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 78 of file wvlistener.h.
|
inlinevirtualinherited |
Sets a callback to be invoked on close().
Implements IWvStream.
Definition at line 86 of file wvlistener.h.
|
inlinevirtualinherited |
set the maximum size of outbuf, beyond which a call to write() will return 0.
Implements IWvStream.
Definition at line 98 of file wvlistener.h.
|
inlinevirtualinherited |
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(), WvDBusServer::geterr(), WvStreamClone::geterr(), WvEncoderStream::isok(), UniConfDaemon::listen(), WvStream::seterr(), and WvMagicCircle::WvMagicCircle().
|
virtualinherited |
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 accept(), WvTCPListener::accept(), WvDSAKey::getpem(), WvGlob::set(), WvStream::seterr(), WvMagicCircle::WvMagicCircle(), WvPam::WvPam(), WvShmZone::WvShmZone(), and WvTCPListener::WvTCPListener().
|
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(), StaticServiceHandler::getObject(), WeakRef::getObject(), WvIStreamList::post_select(), WvQtStreamClone::WvQtStreamClone(), and WvSSLStream::WvSSLStream().
|
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(), NewMoniker::resolve(), and MonikerService::resolve().
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.
|
pure virtualinherited |