ionian 0.5.0 → 0.6.0

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","socket","<<()","closed?()","cmd()","cork()","cork=()","cork?()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","ip_add_membership()","ip_drop_membership()","ip_multicast_if()","ip_multicast_if=()","ip_multicast_loop()","ip_multicast_loop=()","ip_multicast_loop?()","ip_multicast_ttl()","ip_multicast_ttl=()","ipv6_add_membership()","ipv6_drop_membership()","ipv6_multicast_hops()","ipv6_multicast_hops=()","ipv6_multicast_if()","ipv6_multicast_if=()","ipv6_multicast_loop()","ipv6_multicast_loop=()","ipv6_multicast_loop?()","multicast()","multicast?()","new()","no_delay()","no_delay=()","no_delay?()","on_match()","persistent?()","protocol?()","purge()","puts()","read_match()","recork()","register_observer()","reuse_addr()","reuse_addr=()","reuse_addr?()","run_match()","ttl()","ttl=()","ttl?()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::socket","ionian::socket#<<()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::socket#cork()","ionian::extension::socket#cork=()","ionian::extension::socket#cork?()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::extension::socket#ip_add_membership()","ionian::extension::socket#ip_drop_membership()","ionian::extension::socket#ip_multicast_if()","ionian::extension::socket#ip_multicast_if=()","ionian::extension::socket#ip_multicast_loop()","ionian::extension::socket#ip_multicast_loop=()","ionian::extension::socket#ip_multicast_loop?()","ionian::extension::socket#ip_multicast_ttl()","ionian::extension::socket#ip_multicast_ttl=()","ionian::extension::socket#ipv6_add_membership()","ionian::extension::socket#ipv6_drop_membership()","ionian::extension::socket#ipv6_multicast_hops()","ionian::extension::socket#ipv6_multicast_hops=()","ionian::extension::socket#ipv6_multicast_if()","ionian::extension::socket#ipv6_multicast_if=()","ionian::extension::socket#ipv6_multicast_loop()","ionian::extension::socket#ipv6_multicast_loop=()","ionian::extension::socket#ipv6_multicast_loop?()","ionian::extension::socket#multicast()","ionian::extension::socket#multicast?()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::socket#no_delay?()","ionian::extension::io#on_match()","ionian::socket#persistent?()","ionian::socket#protocol?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_match()","ionian::extension::socket#recork()","ionian::extension::io#register_observer()","ionian::extension::socket#reuse_addr()","ionian::extension::socket#reuse_addr=()","ionian::extension::socket#reuse_addr?()","ionian::extension::io#run_match()","ionian::extension::socket#ttl()","ionian::extension::socket#ttl=()","ionian::extension::socket#ttl?()","ionian::extension::io#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","","<p>A collection of mixins.\n"],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Socket","","Ionian/Socket.html","","<p>A convenient wrapper for TCP, UDP, and Unix sockets.\n"],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, **kwargs, &block)","<p>Send a command (data) to the socket. Returns an array of received matches.\nBlock yields received match. …\n"],["cork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork","()","<p>Returns true if multiple writes are buffered into a single segment. See\n#recork. Linux only. ( TCP_CORK …\n"],["cork=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3D","(value)","<p>Buffers multiple writes into a single segment if true. The segment is sent\nonce the cork flag is disabled, …\n"],["cork?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3F","()",""],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(**kwargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()","<p>Initialize the Ionian Socket variables. This is called automatically if\n#extend is called on an object. …\n"],["ip_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_add_membership","(address = nil, interface = nil)","<p>Join a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_drop_membership","(address = nil, interface = nil)","<p>Leave a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if","()","<p>Returns the default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if-3D","(interface = nil)","<p>Specify default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop","()","<p>Returns true if loopback of outgoing multicasts is enabled. (\nIP_MULTICAST_LOOP )\n"],["ip_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3D","(value)","<p>Enables loopback of outgoing multicasts if true. ( IP_MULTICAST_LOOP )\n"],["ip_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3F","()",""],["ip_multicast_ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl","()","<p>Returns the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ip_multicast_ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl-3D","(value)","<p>Set the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ipv6_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_add_membership","()",""],["ipv6_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_drop_membership","()",""],["ipv6_multicast_hops","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops","()",""],["ipv6_multicast_hops=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops-3D","(value)",""],["ipv6_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if","()",""],["ipv6_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if-3D","(value)",""],["ipv6_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop","()",""],["ipv6_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3D","(value)",""],["ipv6_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3F","()",""],["multicast","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast","(address)","<p>Returns true if the given address is within the multicast range.\n"],["multicast?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast-3F","(address)",""],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(**kwargs)","<p>Args:\n\n<pre>host:       IP or hostname to connect to.\nport:       Connection&#39;s port number. Default is 23. Unused ...</pre>\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the Nagle algorithm is disabled. ( TCP_NODELAY )\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Disables the Nagle algorithm if true. ( TCP_NODELAY )\n"],["no_delay?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3F","()",""],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["protocol?","Ionian::Socket","Ionian/Socket.html#method-i-protocol-3F","()","<p>Returns a symbol of the type of protocol this socket uses: :tcp, :udp,\n:unix\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(*string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(**kwargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["recork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-recork","()","<p>Unsets cork to transmit data, then reapplies cork. ( TCP_CORK )\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["reuse_addr","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr","()","<p>Returns true if local address reuse is allowed. ( SO_REUSEADDR )\n"],["reuse_addr=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3D","(value)","<p>Allows local address reuse if true. ( SO_REUSEADDR )\n"],["reuse_addr?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3F","()",""],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(**kwargs)","<p>Start a thread that checks for data and notifies listeners (do |match,\nsocket|). Passes kwargs to #read_match …\n"],["ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl","()","<p>Returns the time to live (hop limit). ( IP_TTL )\n"],["ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3D","(value)","<p>Sets the time to live (hop limit). ( IP_TTL )\n"],["ttl?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3F","()",""],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}
+var search_data = {"index":{"searchIndex":["ionian","extension","io","socket","server","socket","<<()","close()","closed?()","cmd()","cork()","cork=()","cork?()","expression()","expression=()","extended()","extended()","flush()","has_data?()","has_data?()","initialize_ionian()","initialize_ionian_socket()","ip_add_membership()","ip_drop_membership()","ip_multicast_if()","ip_multicast_if=()","ip_multicast_loop()","ip_multicast_loop=()","ip_multicast_loop?()","ip_multicast_ttl()","ip_multicast_ttl=()","ipv6_add_membership()","ipv6_drop_membership()","ipv6_multicast_hops()","ipv6_multicast_hops=()","ipv6_multicast_if()","ipv6_multicast_if=()","ipv6_multicast_loop()","ipv6_multicast_loop=()","ipv6_multicast_loop?()","listen()","multicast()","multicast?()","new()","new()","no_delay()","no_delay=()","no_delay?()","on_accept()","on_match()","on_match()","persistent?()","purge()","puts()","read_all()","read_match()","recork()","register_accept_listener()","register_observer()","register_observer()","reuse_addr()","reuse_addr=()","reuse_addr?()","run_match()","ttl()","ttl=()","ttl?()","unregister_accept_listener()","unregister_observer()","unregister_observer()","write()"],"longSearchIndex":["ionian","ionian::extension","ionian::extension::io","ionian::extension::socket","ionian::server","ionian::socket","ionian::socket#<<()","ionian::server#close()","ionian::socket#closed?()","ionian::socket#cmd()","ionian::extension::socket#cork()","ionian::extension::socket#cork=()","ionian::extension::socket#cork?()","ionian::extension::io#expression()","ionian::extension::io#expression=()","ionian::extension::io::extended()","ionian::extension::socket::extended()","ionian::socket#flush()","ionian::extension::io#has_data?()","ionian::socket#has_data?()","ionian::extension::io#initialize_ionian()","ionian::extension::socket#initialize_ionian_socket()","ionian::extension::socket#ip_add_membership()","ionian::extension::socket#ip_drop_membership()","ionian::extension::socket#ip_multicast_if()","ionian::extension::socket#ip_multicast_if=()","ionian::extension::socket#ip_multicast_loop()","ionian::extension::socket#ip_multicast_loop=()","ionian::extension::socket#ip_multicast_loop?()","ionian::extension::socket#ip_multicast_ttl()","ionian::extension::socket#ip_multicast_ttl=()","ionian::extension::socket#ipv6_add_membership()","ionian::extension::socket#ipv6_drop_membership()","ionian::extension::socket#ipv6_multicast_hops()","ionian::extension::socket#ipv6_multicast_hops=()","ionian::extension::socket#ipv6_multicast_if()","ionian::extension::socket#ipv6_multicast_if=()","ionian::extension::socket#ipv6_multicast_loop()","ionian::extension::socket#ipv6_multicast_loop=()","ionian::extension::socket#ipv6_multicast_loop?()","ionian::server#listen()","ionian::extension::socket#multicast()","ionian::extension::socket#multicast?()","ionian::server::new()","ionian::socket::new()","ionian::extension::socket#no_delay()","ionian::extension::socket#no_delay=()","ionian::extension::socket#no_delay?()","ionian::server#on_accept()","ionian::extension::io#on_match()","ionian::socket#on_match()","ionian::socket#persistent?()","ionian::extension::io#purge()","ionian::socket#puts()","ionian::extension::io#read_all()","ionian::extension::io#read_match()","ionian::extension::socket#recork()","ionian::server#register_accept_listener()","ionian::extension::io#register_observer()","ionian::socket#register_observer()","ionian::extension::socket#reuse_addr()","ionian::extension::socket#reuse_addr=()","ionian::extension::socket#reuse_addr?()","ionian::extension::io#run_match()","ionian::extension::socket#ttl()","ionian::extension::socket#ttl=()","ionian::extension::socket#ttl?()","ionian::server#unregister_accept_listener()","ionian::extension::io#unregister_observer()","ionian::socket#unregister_observer()","ionian::socket#write()"],"info":[["Ionian","","Ionian.html","","<p>A library to simplify interaction with IO streams. This includes network\nsockets, file sockets, and serial …\n"],["Ionian::Extension","","Ionian/Extension.html","","<p>A collection of mixins.\n"],["Ionian::Extension::IO","","Ionian/Extension/IO.html","","<p>A mixin for IO objects that allows regular expression matching and\nconvenient notification of received …\n"],["Ionian::Extension::Socket","","Ionian/Extension/Socket.html","","<p>A mixin for Socket objects.\n<p>This module was designed to be extended by instantiated objects that\nimplement …\n"],["Ionian::Server","","Ionian/Server.html","","<p>A convenient wrapper for TCP, UDP, and Unix server sockets.\n"],["Ionian::Socket","","Ionian/Socket.html","","<p>A convenient wrapper for TCP, UDP, and Unix client sockets.\n"],["<<","Ionian::Socket","Ionian/Socket.html#method-i-3C-3C","(string)",""],["close","Ionian::Server","Ionian/Server.html#method-i-close","()","<p>Shutdown the server socket and stop listening for connections.\n"],["closed?","Ionian::Socket","Ionian/Socket.html#method-i-closed-3F","()","<p>Returns true if the socket is closed.\n"],["cmd","Ionian::Socket","Ionian/Socket.html#method-i-cmd","(string, **kwargs, &block)","<p>Send a command (data) to the socket. Returns an array of received matches.\nBlock yields received match. …\n"],["cork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork","()","<p>Returns true if multiple writes are buffered into a single segment. See\n#recork. Linux only. ( TCP_CORK …\n"],["cork=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3D","(value)","<p>Buffers multiple writes into a single segment if true. The segment is sent\nonce the cork flag is disabled, …\n"],["cork?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-cork-3F","()",""],["expression","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression","()","<p>Returns the regular expression used for #read_match.\n"],["expression=","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-expression-3D","(exp)","<p>Set the expression to match against the read buffer. Can be a regular\nexpression specifying capture groups, …\n"],["extended","Ionian::Extension::IO","Ionian/Extension/IO.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["extended","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-c-extended","(obj)","<p>Called automaticallly when the object is extended with #extend.\n"],["flush","Ionian::Socket","Ionian/Socket.html#method-i-flush","()","<p>Flushes buffered data to the operating system. This method has no effect on\nnon-persistent sockets.\n"],["has_data?","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-has_data-3F","(timeout: 0)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["has_data?","Ionian::Socket","Ionian/Socket.html#method-i-has_data-3F","(**kwargs)","<p>Returns true if there is data in the receive buffer. Args:\n\n<pre>Timeout: Number of seconds to wait for data ...</pre>\n"],["initialize_ionian","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-initialize_ionian","()","<p>Initialize the Ionian instance variables. This is called automatically if\n#extend is called on an object. …\n"],["initialize_ionian_socket","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-initialize_ionian_socket","()","<p>Initialize the Ionian Socket variables. This is called automatically if\n#extend is called on an object. …\n"],["ip_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_add_membership","(address = nil, interface = nil)","<p>Join a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_drop_membership","(address = nil, interface = nil)","<p>Leave a multicast group. Address is the class D multicast address (uses\nremote address if not specified). …\n"],["ip_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if","()","<p>Returns the default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_if-3D","(interface = nil)","<p>Specify default interface for outgoing multicasts. ( IP_MULTICAST_IF )\n"],["ip_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop","()","<p>Returns true if loopback of outgoing multicasts is enabled. (\nIP_MULTICAST_LOOP )\n"],["ip_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3D","(value)","<p>Enables loopback of outgoing multicasts if true. ( IP_MULTICAST_LOOP )\n"],["ip_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_loop-3F","()",""],["ip_multicast_ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl","()","<p>Returns the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ip_multicast_ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ip_multicast_ttl-3D","(value)","<p>Set the time to live (hop limit) for outgoing multicasts. (\nIP_MULTICAST_TTL )\n"],["ipv6_add_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_add_membership","()",""],["ipv6_drop_membership","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_drop_membership","()",""],["ipv6_multicast_hops","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops","()",""],["ipv6_multicast_hops=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_hops-3D","(value)",""],["ipv6_multicast_if","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if","()",""],["ipv6_multicast_if=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_if-3D","(value)",""],["ipv6_multicast_loop","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop","()",""],["ipv6_multicast_loop=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3D","(value)",""],["ipv6_multicast_loop?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ipv6_multicast_loop-3F","()",""],["listen","Ionian::Server","Ionian/Server.html#method-i-listen","(&block)","<p>Starts the socket server listening for connections. Blocks registered with\n#register_accept_listener …\n"],["multicast","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast","(address)","<p>Returns true if the given address is within the multicast range.\n"],["multicast?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-multicast-3F","(address)",""],["new","Ionian::Server","Ionian/Server.html#method-c-new","(**kwargs, &block)",""],["new","Ionian::Socket","Ionian/Socket.html#method-c-new","(existing_socket = nil, **kwargs)","<p>Creates a new socket or wraps an existing socket.\n<p>Args:\n\n<pre>host:       IP or hostname to connect to.\nport: ...</pre>\n"],["no_delay","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay","()","<p>Returns true if the Nagle algorithm is disabled. ( TCP_NODELAY )\n"],["no_delay=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3D","(value)","<p>Disables the Nagle algorithm if true. ( TCP_NODELAY )\n"],["no_delay?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-no_delay-3F","()",""],["on_accept","Ionian::Server","Ionian/Server.html#method-i-on_accept","(&block)",""],["on_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-on_match","(&block)",""],["on_match","Ionian::Socket","Ionian/Socket.html#method-i-on_match","(&block)",""],["persistent?","Ionian::Socket","Ionian/Socket.html#method-i-persistent-3F","()","<p>Returns true if the socket remains open after writing data.\n"],["purge","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-purge","()","<p>Erase the data in the IO and Ionian buffers. This is typically handled\nautomatically.\n"],["puts","Ionian::Socket","Ionian/Socket.html#method-i-puts","(*string)","<p>Writes the given string(s) to the socket and appends a newline character to\nany string not already ending …\n"],["read_all","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_all","()","<p>Read all data in the buffer. An alternative to using #readpartial with a\nlarge length.\n"],["read_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-read_match","(**kwargs, &block)","<p>Read matched data from the buffer. This method SHOULD NOT be used if\n#run_match is used.\n<p>Passes matches …\n"],["recork","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-recork","()","<p>Unsets cork to transmit data, then reapplies cork. ( TCP_CORK )\n"],["register_accept_listener","Ionian::Server","Ionian/Server.html#method-i-register_accept_listener","(&block)","<p>Register a block to be run when server accepts a client connection. The\nconnected client is passed to …\n"],["register_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["register_observer","Ionian::Socket","Ionian/Socket.html#method-i-register_observer","(&block)","<p>Register a block to be called when #run_match receives matched data. Method\ncallbacks can be registered …\n"],["reuse_addr","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr","()","<p>Returns true if local address reuse is allowed. ( SO_REUSEADDR )\n"],["reuse_addr=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3D","(value)","<p>Allows local address reuse if true. ( SO_REUSEADDR )\n"],["reuse_addr?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-reuse_addr-3F","()",""],["run_match","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-run_match","(**kwargs)","<p>Start a thread that checks for data and notifies listeners (do |match,\nsocket|). Passes kwargs to #read_match …\n"],["ttl","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl","()","<p>Returns the time to live (hop limit). ( IP_TTL )\n"],["ttl=","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3D","(value)","<p>Sets the time to live (hop limit). ( IP_TTL )\n"],["ttl?","Ionian::Extension::Socket","Ionian/Extension/Socket.html#method-i-ttl-3F","()",""],["unregister_accept_listener","Ionian::Server","Ionian/Server.html#method-i-unregister_accept_listener","(proc)","<p>Unregisters a socket accept notifier block.\n"],["unregister_observer","Ionian::Extension::IO","Ionian/Extension/IO.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["unregister_observer","Ionian::Socket","Ionian/Socket.html#method-i-unregister_observer","(&block)","<p>Unregister a block from being called when matched data is received.\n"],["write","Ionian::Socket","Ionian/Socket.html#method-i-write","(string)","<p>Writes the given string to the socket. Returns the number of bytes written.\n"]]}}

data/doc/rdoc.css

@@ -193,7 +193,8 @@ nav h2 {
   text-align: center;
 }
 
-nav h3 {
+nav h3,
+#table-of-contents-navigation {
   margin: 0;
   padding: 2px 8px 2px 8px;
   text-align: right;
@@ -213,8 +214,13 @@ nav p {
   border-top: 0;
 }
 
-#home-section h2,
-#home-section h3 {
+#home-section h2 {
+  text-align: center;
+}
+
+#table-of-contents-navigation {
+  font-size: 1.2em;
+  font-weight: bold;
   text-align: center;
 }
 

data/doc/table_of_contents.html

@@ -40,6 +40,9 @@
   <li class="module">
     <a href="Ionian/Extension/Socket.html">Ionian::Extension::Socket</a>
   </li>
+  <li class="class">
+    <a href="Ionian/Server.html">Ionian::Server</a>
+  </li>
   <li class="class">
     <a href="Ionian/Socket.html">Ionian::Socket</a>
   </li>
@@ -49,25 +52,35 @@
 <ul>
 
   <li class="method">
-    <a href="Ionian/Extension/IO.html#method-c-extended">::extended</a>
+    <a href="Ionian/Extension/Socket.html#method-c-extended">::extended</a>
     &mdash;
-    <span class="container">Ionian::Extension::IO</span>
+    <span class="container">Ionian::Extension::Socket</span>
 
   <li class="method">
-    <a href="Ionian/Extension/Socket.html#method-c-extended">::extended</a>
+    <a href="Ionian/Extension/IO.html#method-c-extended">::extended</a>
     &mdash;
-    <span class="container">Ionian::Extension::Socket</span>
+    <span class="container">Ionian::Extension::IO</span>
 
   <li class="method">
     <a href="Ionian/Socket.html#method-c-new">::new</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
   <li class="method">
     <a href="Ionian/Socket.html#method-i-3C-3C">#&lt;&lt;</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-i-close">#close</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
   <li class="method">
     <a href="Ionian/Socket.html#method-i-closed-3F">#closed?</a>
     &mdash;
@@ -218,6 +231,11 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-i-listen">#listen</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
   <li class="method">
     <a href="Ionian/Extension/Socket.html#method-i-multicast">#multicast</a>
     &mdash;
@@ -243,18 +261,23 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-i-on_accept">#on_accept</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-on_match">#on_match</a>
     &mdash;
     <span class="container">Ionian::Extension::IO</span>
 
   <li class="method">
-    <a href="Ionian/Socket.html#method-i-persistent-3F">#persistent?</a>
+    <a href="Ionian/Socket.html#method-i-on_match">#on_match</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
 
   <li class="method">
-    <a href="Ionian/Socket.html#method-i-protocol-3F">#protocol?</a>
+    <a href="Ionian/Socket.html#method-i-persistent-3F">#persistent?</a>
     &mdash;
     <span class="container">Ionian::Socket</span>
 
@@ -268,6 +291,11 @@
     &mdash;
     <span class="container">Ionian::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Extension/IO.html#method-i-read_all">#read_all</a>
+    &mdash;
+    <span class="container">Ionian::Extension::IO</span>
+
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-read_match">#read_match</a>
     &mdash;
@@ -278,11 +306,21 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-i-register_accept_listener">#register_accept_listener</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-register_observer">#register_observer</a>
     &mdash;
     <span class="container">Ionian::Extension::IO</span>
 
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-register_observer">#register_observer</a>
+    &mdash;
+    <span class="container">Ionian::Socket</span>
+
   <li class="method">
     <a href="Ionian/Extension/Socket.html#method-i-reuse_addr">#reuse_addr</a>
     &mdash;
@@ -318,6 +356,16 @@
     &mdash;
     <span class="container">Ionian::Extension::Socket</span>
 
+  <li class="method">
+    <a href="Ionian/Server.html#method-i-unregister_accept_listener">#unregister_accept_listener</a>
+    &mdash;
+    <span class="container">Ionian::Server</span>
+
+  <li class="method">
+    <a href="Ionian/Socket.html#method-i-unregister_observer">#unregister_observer</a>
+    &mdash;
+    <span class="container">Ionian::Socket</span>
+
   <li class="method">
     <a href="Ionian/Extension/IO.html#method-i-unregister_observer">#unregister_observer</a>
     &mdash;
@@ -333,7 +381,7 @@
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.preview.1.
+  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>
 

data/lib/ionian/extension/io.rb

@@ -51,6 +51,12 @@ module Ionian
         @ionian_expression = Regexp.new "(.*?)#{expression}" if exp.is_a? String
       end
       
+      # Read all data in the buffer.
+      # An alternative to using #readpartial with a large length.
+      def read_all
+        readpartial 0xFFFF
+      end
+      
       # Read matched data from the buffer.
       # This method SHOULD NOT be used if #run_match is used.
       #
@@ -72,7 +78,7 @@ module Ionian
       #   timeout:        Timeout in seconds IO::select will block.
       #   skip_select:    Skip over the IO::select statement. Use if you
       #                   are calling IO::select ahead of this method.
-      #   build_methods:  Build method accessors from named captures.
+      #   build_methods:  Build accessor methods from named capture groups.
       #                   Enabled by default.
       def read_match(**kwargs, &block)
         timeout       = kwargs.fetch :timeout, @ionian_timeout

data/lib/ionian/server.rb

@@ -0,0 +1,85 @@
+require 'socket'
+require 'ionian/socket'
+
+module Ionian
+  
+  # A convenient wrapper for TCP, UDP, and Unix server sockets.
+  class Server
+    
+    def initialize **kwargs, &block
+      @accept_listeners = []
+      register_accept_listener &block if block_given?
+      
+      @interface = kwargs.fetch :interface, ''
+      @port      = kwargs.fetch :port, nil
+      
+      
+      # Automatically select UDP for the multicast range. Otherwise default to TCP.
+      default_protocol = :tcp
+      # TODO: This ivar may be incorrect for UDP -- bound interface is not destination.
+      default_protocol = :udp  if Ionian::Extension::Socket.multicast? @interface
+      default_protocol = :unix if @interface.start_with? '/'
+      
+      @protocol  = kwargs.fetch :protocol, default_protocol
+      
+      # TODO: Move this to #listen.
+      case @protocol
+      when :tcp
+        @server = TCPServer.new @interface, @port
+        @server.setsockopt ::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, [1].pack('i')
+      when :udp
+        @server = Ionian::Socket.new host: @interface, port: @port, protocol: :udp
+      when :unix
+        @server = UNIXServer.new @interface
+      end
+    end
+    
+    # Starts the socket server listening for connections.
+    # Blocks registered with #register_accept_listener will
+    # be run when a connection is accepted.
+    def listen &block
+      register_accept_listener &block if block_given?
+      
+      @accept_thread ||= Thread.new do
+        # Package in an Ionian::Socket
+        begin
+          client = Ionian::Socket.new @server.accept
+          
+          @accept_listeners.each do |listener|
+            listener.call client
+          end
+        rescue Errno::EBADF
+          # This ignores the connection if the client closed it before it
+          # could be accepted.
+        rescue IOError
+          # This ignores the connection if the client closed it before it
+          # could be accepted.
+        end
+      end
+    end
+    
+    # Shutdown the server socket and stop listening for connections.
+    def close
+      @server.close if @server
+      @accept_thread.join if @accept_thread
+      @accept_thread = nil
+    end
+    
+    # Register a block to be run when server accepts a client connection.
+    # The connected client is passed to the block as an Ionain::Client.
+    def register_accept_listener &block
+      @accept_listeners << block unless @accept_listeners.include? block
+      block
+    end
+    
+    alias_method :on_accept, :register_accept_listener
+    
+    # Unregisters a socket accept notifier block.
+    def unregister_accept_listener proc
+      @accept_listeners.delete_if {|o| o == proc} 
+      proc
+    end
+    
+  end
+  
+end

data/lib/ionian/socket.rb

@@ -2,9 +2,12 @@ require 'ionian/extension/socket'
 
 module Ionian
   
-  # A convenient wrapper for TCP, UDP, and Unix sockets.
+  # A convenient wrapper for TCP, UDP, and Unix client sockets.
   class Socket
+    attr_accessor :expression
     
+    # Creates a new socket or wraps an existing socket.
+    # 
     # Args:
     #   host:       IP or hostname to connect to.
     #   port:       Connection's port number. Default is 23. Unused by :unix protocol.
@@ -20,37 +23,70 @@ module Ionian
     #   cork:       Set true to enable the TCP_CORK flag. Buffers multiple writes
     #               into one segment.
     #   expression: Overrides the #read_match regular expression for received data.
-    def initialize(**kwargs)
-      @socket         = nil
+    def initialize(existing_socket = nil, **kwargs)
+      @socket = existing_socket
       
-      # TODO: Should be able to parse the port out of host.
-      #       :port should override this parsed value.
+      @ionian_listeners = []
       
-      @host           = kwargs.fetch :host
-      @port           = kwargs.fetch :port,       23
-      @bind_port      = kwargs.fetch :bind_port,  @port
+      @expression = kwargs.fetch :expression, nil
       
-      # Automatically select UDP for the multicast range. Otherwise default to TCP.
-      default_protocol = :tcp
-      default_protocol = :udp  if Ionian::Extension::Socket.multicast? @host
-      default_protocol = :unix if @host.start_with? '/'
+      if existing_socket
+        # Convert existing socket.
+        @socket.extend Ionian::Extension::IO
+        @socket.extend Ionian::Extension::Socket
+        
+        if existing_socket.is_a? UNIXSocket
+          @host = existing_socket.path
+          @port = nil
+        else
+          @host = existing_socket.remote_address.ip_address if existing_socket
+          @port = existing_socket.remote_address.ip_port if existing_socket
+        end
       
-      @protocol       = kwargs.fetch :protocol,   default_protocol
-      @persistent     = kwargs.fetch :persistent, true
-      @expression     = kwargs.fetch :expression, nil
+        if @socket.is_a? TCPSocket
+          @protocol = :tcp
+        elsif @socket.is_a? UDPSocket
+          @protocol = :udp
+        elsif @socket.is_a? UNIXSocket
+          @protocol = :unix
+        end
+        
+        @persistent     = true # Existing sockets are always persistent.
+        
+        @socket.expression = @expression if @expression
+        
+        initialize_socket_methods
+      else
+        # Initialize new socket.
+        
+        # TODO: Should be able to parse the port out of host.
+        #       :port should override this parsed value.
+        
+        @host           = kwargs.fetch :host
+        @port           = kwargs.fetch :port,       23
+        @bind_port      = kwargs.fetch :bind_port,  @port
       
-      @reuse_addr     = kwargs.fetch :reuse_addr, false
-      @no_delay       = kwargs.fetch :no_delay,   false
-      @cork           = kwargs.fetch :cork,       false
+        # Automatically select UDP for the multicast range. Otherwise default to TCP.
+        default_protocol = :tcp
+        default_protocol = :udp  if Ionian::Extension::Socket.multicast? @host
+        default_protocol = :unix if @host.start_with? '/'
+        
+        @protocol       = kwargs.fetch :protocol,   default_protocol
+        @persistent     = kwargs.fetch :persistent, true
+        
+        @reuse_addr     = kwargs.fetch :reuse_addr, false
+        @no_delay       = kwargs.fetch :no_delay,   false
+        @cork           = kwargs.fetch :cork,       false
       
-      create_socket if @persistent
+        
+        create_socket if @persistent
+      end
     end
         
     # Returns a symbol of the type of protocol this socket uses:
     # :tcp, :udp, :unix
-    def protocol?
-      @protocol
-    end
+    attr_reader :protocol
+    alias_method :protocol?, :protocol
     
     # Returns true if the socket remains open after writing data.
     def persistent?
@@ -78,6 +114,24 @@ module Ionian
       matches
     end
     
+    # Register a block to be called when #run_match receives matched data.
+    # Method callbacks can be registered with &object.method(:method).
+    # Returns a reference to the given block.
+    # block = ionian_socket.register_observer {...}
+    def register_observer &block
+      @ionian_listeners << block unless @ionian_listeners.include? block
+      @socket.register_observer &block if @socket
+      block
+    end
+    
+    alias_method :on_match, :register_observer
+    
+    # Unregister a block from being called when matched data is received.
+    def unregister_observer(&block)
+      @ionian_listeners.delete_if {|o| o == block}
+      @socket.unregister_observer &block if @socket
+      block
+    end
     
     ### Methods Forwarded To @socket ###
     
@@ -145,6 +199,7 @@ module Ionian
       when :tcp
         @socket = ::TCPSocket.new @host, @port
         @socket.extend Ionian::Extension::Socket
+        @socket.expression = @expression if @expression
         @socket.no_delay = true if @no_delay
         @socket.cork = true if @cork
         
@@ -170,6 +225,9 @@ module Ionian
       
       @socket.expression = @expression if @expression
       
+      # Register listeners.
+      @ionian_listeners.each { |proc| @socket.on_match &proc }
+      
       initialize_socket_methods
     end
     

data/lib/ionian.rb

@@ -1,6 +1,7 @@
 require 'ionian/extension/io'
 require 'ionian/extension/socket'
 require 'ionian/socket'
+require 'ionian/server'
 
 # A library to simplify interaction with IO streams.
 # This includes network sockets, file sockets, and