GenericSocket

General methods for an asynchronous socket.

abstract

class GenericSocket {

mixin SocketMixin ;

Socket socket [@property getter];

void onReadable();

void onWritable();

void onError(string );

Address _address [@property getter];

alias localAddress = _address!true;

alias remoteAddress = _address!false;

string _addressStr [@property getter];

alias localAddressStr = _addressStr!true;

alias remoteAddressStr = _addressStr!false;

bool daemonRead;

bool daemonWrite;

alias daemon = daemonRead;

void setKeepAlive(bool enabled, int time, int interval);

string toString();

}

Members

Aliases

daemon deprecated alias daemon = daemonRead: Undocumented in source.
localAddress alias localAddress = _address!true: Undocumented in source.
localAddressStr alias localAddressStr = _addressStr!true: Undocumented in source.
remoteAddress alias remoteAddress = _address!false: Undocumented in source.
remoteAddressStr alias remoteAddressStr = _addressStr!false: Undocumented in source.

Functions

onError void onError(string ): Undocumented in source. Be warned that the author may not have intended to support it.
onReadable void onReadable(): Undocumented in source. Be warned that the author may not have intended to support it.
onWritable void onWritable(): Undocumented in source. Be warned that the author may not have intended to support it.
setKeepAlive void setKeepAlive(bool enabled, int time, int interval): Enable TCP keep-alive on the socket with the given settings.
toString string toString(): Returns a string containing the class name, address, and file descriptor.

Mixins

__anonymous mixin SocketMixin: Declares notifyRead and notifyWrite.

Properties

_address Address _address [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
_addressStr string _addressStr [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
socket Socket socket [@property getter]: Retrieve the socket class this class wraps.

Variables

conn Socket conn;: The socket this class wraps.
daemonRead bool daemonRead;: Don't block the process from exiting, even if the socket is ready to receive data. TODO: Not implemented with libev
daemonWrite bool daemonWrite;: Don't block the process from exiting, even if the socket is ready to send data. TODO: Not implemented with libev

Mixed In Members

From `mixin SocketMixin`

notifyRead bool notifyRead;: Interested in read notifications (onReadable)?
notifyWrite bool notifyWrite;: Interested in write notifications (onWritable)?

Meta

Source

See Implementation