Ruby » Ruby master

    /*

     * Document-class: Socket::AncillaryData

     *

     * Socket::AncillaryData represents the ancillary data (control information)

     * used by sendmsg and recvmsg system call.

     * It contains socket family, cmsg level, cmsg type and cmsg data.

     */

    /*

     * Document-class: BasicSocket < IO

     *

     * BasicSocket is the super class for all the socket classes.

     */

    /*

     * SocketError is the error class for socket.

     */

    /*

     * Document-class: IPSocket < BasicSocket

     *

     * IPSocket is the super class of TCPSocket and UDPSocket.

     */

    # _remote_adress_ is a Addrinfo object.

    #

    # _local_adress_ is a Addrinfo object.

    #

    # _reply_proc_ is a Proc used to send reply back to source.

    # :attr_reader: remote_address

    # Address of the source

    attr_reader :remote_address

    # :attr_reader: local_address

    # Local address

    attr_reader :local_address

    # inspection of a UDPSource object.

    # :call-seq:

    #   udp_source.reply(msg)

    #

    # Respond to UDP source.

    #

    # _msg_ is a string.

    /*

     * Document-module: ::Socket::Constants

     *

     * Socket::Constants provides socket related constants.

     * Following lists possible constants.

     * If underlying platform doesn't define a constant,

     * the corresponding Ruby constant is not defined.

     *

     */

    /*

     * Document-class: Socket::Option

     *

     * Socket::Option represents a socket option used by getsockopt and setsockopt

     * system call.

     * It contains socket family, protocol level, option name and option value.

     */

    /*

     * Addrinfo class maps the +addrinfo+ struct. This structure identifies an Internet host and a service.

     */

    /*

     * Document-class: Socket < BasicSocket

     *

     * Class +Socket+ provides access to the underlying operating system

     * socket implementations. It can be used to provide more operating system

     * specific functionality than the protocol-specific socket classes.

     *

     * The constants defined under Socket::Constants are also defined under Socket.

     * For example, Socket::AF_INET is usable as well as Socket::Constants::AF_INET.

     * See Socket::Constants for the list of constants.

     *

     * === What's a socket ?

     * Sockets are endpoints of a bidirectionnal communication channel. Sockets can communicate

     * within a process, and between processes on the same machine or on different machines. There

     * are many types of socket : TCPSocket, UDPSocket or UNIXSocket by example.

     *

     * Sockets have their own vocabulary :

     * *domain*:: the family of protocols :  Socket::PF_INET, Socket::PF_INET6,

     *            Socket::PF_UNIX, etc.

     * *type*::   the type of communications between le endpoints, typically 

     *            Socket::SOCK_STREAM or Socket::SOCK_DGRAM.

     * *protocol*:: typically zero. This may be used to identify a variant of a

     *              protocol.

     * *hostname*:: the identifier of a network interface : 

     *              * a string (hostname, IPv4 or IPv6 adress, <tt><broadcast></tt> which specifies a 

     *                broadcast address), 

     *              * a zero-length string which specifies INADDR_ANY,

     *              * an integer (interpreted as binary address in host byte order).

     *

     * === Quick start

     * Some classes, as TCPSocket, UDPSocket or UNIXSocket ease use of sockets of these types.

     *  # Socket way

     *  s = Socket.new(Socket::INET, Socket::SOCK_STREAM) # Create a TCP socket. s is a Socket object

     *  s.connect(Socket.pack_sockaddr_in(80, 'www.google.com'))

     *  

     *  # TCPSocket simpler way

     *  s = TCPSocket.new('www.google.com', 80)           # Create a TCP socket. s is a TCPSocket object

     *

     * A simple server may look like :

     *  require 'socket'

     *  

     *  server = TCPServer.new(2000)   # Server bind to port 2000

     *  loop do

     *    client = server.accept       # Wait for a client to connect

     *    client.puts "Hello !"

     *    client.puts "Time is #{Time.now}"

     *    client.close

     *  end

     *

     * A simple client may look like :

     *  require 'socket'

     *  

     *  s = TCPSocket.new('localhost', 2000) # open a TCP socket on localhost on port 2000

     *  

     *  while line = s.gets                  # Read lines from socket

     *    puts line                          # and print them

     *  end

     *  

     *  s.close                              # close socket when done

     *

     * === Exception Handling

     * Ruby's implementation of +Socket+ causes an exception to be raised

     * based on the error generated by the system dependent implementation.

     * This is why the methods are documented in a way that isolate

     * Unix-based system exceptions from Windows based exceptions. If more

     * information on particular exception is needed please refer to the

     * Unix manual pages or the Windows WinSock reference.

     *

     * === Convenient methods

     *

     * Although the general way to create socket is Socket.new,

     * there are several methods for socket creation for most cases.

     *

     * * TCP client socket: Socket.tcp, TCPSocket.open

     * * TCP server socket: Socket.tcp_server_loop, TCPServer.open

     * * UNIX client socket: Socket.unix, UNIXSocket.open

     * * UNIX server socket: Socket.unix_server_loop, UNIXServer.open

     *

     * === Documentation by

     * * Zach Dennis

     * * Sam Roberts

     * * <em>Programming Ruby</em> from The Pragmatic Bookshelf.

     *

     * Much material in this documentation is taken with permission from

     * <em>Programming Ruby</em> from The Pragmatic Bookshelf.

     */

/*

 * call-seq:

 *   SOCKSSocket.new(host, serv) => socket

 *

 * Opens a SOCKS connection to +host+ via +serv+ SOCKS server.

 *

 */

/*

 * Close a connection.

 *

 */

    /*

     * Document-class: SOCKSSocket < TCPSocket

     *

     * SOCKS is an Internet protocol that routes packets between a client and a server 

     * through a proxy server. SOCKS5, if supported, additionnaly provides authentification

     * so only authorized users may access a server.

     */

    /*

     * Document-class: TCPServer < TCPSocket

     *

     * TCPServer represents a TCP/IP server socket.

     *

     * A simple TCP server may look like :

     *  require 'socket'

     *  

     *  server = TCPServer.new(2000)   # Server bind to port 2000

     *  loop do

     *    client = server.accept       # Wait for a client to connect

     *    client.puts "Hello !"

     *    client.puts "Time is #{Time.now}"

     *    client.close

     *  end

     *

     * A more usable server (serving multiple clients) :

     *  require 'socket'

     *  

     *  server = TCPServer.new(2000)

     *  loop do

     *    Thread.start(server.accept) do |client|

     *      client.puts "Hello !"

     *      client.puts "Time is #{Time.now}"

     *      client.close

     *    end

     *  end

     *

     */

    /*

     * Document-class: TCPSocket < IPSocket

     *

     * TCPSocket represents a TCP/IP client socket.

     *

     * Sockets are endpoints of a bidirectionnal communication channel. Sockets can communicate

     * within a process, and between processes on the same machine or on different machines. TCP socket

     * is one of sockets (as UDPSocket or UNIXSocket).

     *

     *

     */

    /*

     * Document-class: UDPSocket < IPSocket

     *

     * UDPSocket represents a UDP/IP socket.

     *

     * Sockets are endpoints of a bidirectionnal communication channel. Sockets can communicate

     * within a process, and between processes on the same machine or on different machines. UDP socket

     * is one of sockets (as TCPSocket or UNIXSocket).

     *

     */

    /*

     * Document-class: UNIXServer < UNIXSocket

     *

     * UNIXServer represents a UNIX domain stream server socket.

     */

    /*

     * Document-class: UNIXSocket < BasicSocket

     *

     * UNIXSocket represents a UNIX domain stream client socket.

     */