Save This Page
Home » openjdk-7 » java » net » [javadoc | source]
abstract public class: SocketImpl [javadoc | source]

All Implemented Interfaces:

Direct Known Subclasses:
    SocksSocketImpl, SdpSocketImpl, DualStackPlainSocketImpl, TwoStacksPlainSocketImpl, AbstractPlainSocketImpl, ZSocketImpl, PlainSocketImpl

The abstract class SocketImpl is a common superclass of all classes that actually implement sockets. It is used to create both client and server sockets.

A "plain" socket implements these methods exactly as described, without attempting to go through a firewall or proxy.

Field Summary
 Socket socket    The actual Socket object. 
 ServerSocket serverSocket     
protected  FileDescriptor fd    The file descriptor object for this socket. 
protected  InetAddress address    The IP address of the remote end of this socket. 
protected  int port    The port number on the remote host to which this socket is connected. 
protected  int localport    The local port number to which this socket is connected. 
Method from Summary:
accept,   available,   bind,   close,   connect,   connect,   connect,   create,   getFileDescriptor,   getInetAddress,   getInputStream,   getLocalPort,   getOutputStream,   getPort,   getServerSocket,   getSocket,   listen,   reset,   sendUrgentData,   setPerformancePreferences,   setServerSocket,   setSocket,   shutdownInput,   shutdownOutput,   supportsUrgentData,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from Detail:
 abstract protected  void accept(SocketImpl s) throws IOException
    Accepts a connection.
 abstract protected int available() throws IOException
    Returns the number of bytes that can be read from this socket without blocking.
 abstract protected  void bind(InetAddress host,
    int port) throws IOException
    Binds this socket to the specified local IP address and port number.
 abstract protected  void close() throws IOException
    Closes this socket.
 abstract protected  void connect(String host,
    int port) throws IOException
    Connects this socket to the specified port on the named host.
 abstract protected  void connect(InetAddress address,
    int port) throws IOException
    Connects this socket to the specified port number on the specified host.
 abstract protected  void connect(SocketAddress address,
    int timeout) throws IOException
    Connects this socket to the specified port number on the specified host. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs.
 abstract protected  void create(boolean stream) throws IOException
    Creates either a stream or a datagram socket.
 protected FileDescriptor getFileDescriptor() 
    Returns the value of this socket's fd field.
 protected InetAddress getInetAddress() 
    Returns the value of this socket's address field.
 abstract protected InputStream getInputStream() throws IOException
    Returns an input stream for this socket.
 protected int getLocalPort() 
    Returns the value of this socket's localport field.
 abstract protected OutputStream getOutputStream() throws IOException
    Returns an output stream for this socket.
 protected int getPort() 
    Returns the value of this socket's port field.
 ServerSocket getServerSocket() 
 Socket getSocket() 
 abstract protected  void listen(int backlog) throws IOException
    Sets the maximum queue length for incoming connection indications (a request to connect) to the count argument. If a connection indication arrives when the queue is full, the connection is refused.
  void reset() throws IOException 
 abstract protected  void sendUrgentData(int data) throws IOException
    Send one byte of urgent data on the socket. The byte to be sent is the low eight bits of the parameter
 protected  void setPerformancePreferences(int connectionTime,
    int latency,
    int bandwidth) 
    Sets performance preferences for this socket.

    Sockets use the TCP/IP protocol by default. Some implementations may offer alternative protocols which have different performance characteristics than TCP/IP. This method allows the application to express its own preferences as to how these tradeoffs should be made when the implementation chooses from the available protocols.

    Performance preferences are described by three integers whose values indicate the relative importance of short connection time, low latency, and high bandwidth. The absolute values of the integers are irrelevant; in order to choose a protocol the values are simply compared, with larger values indicating stronger preferences. Negative values represent a lower priority than positive values. If the application prefers short connection time over both low latency and high bandwidth, for example, then it could invoke this method with the values (1, 0, 0). If the application prefers high bandwidth above low latency, and low latency above short connection time, then it could invoke this method with the values (0, 1, 2). By default, this method does nothing, unless it is overridden in a a sub-class.

  void setServerSocket(ServerSocket soc) 
  void setSocket(Socket soc) 
 protected  void shutdownInput() throws IOException 
    Places the input stream for this socket at "end of stream". Any data sent to this socket is acknowledged and then silently discarded. If you read from a socket input stream after invoking shutdownInput() on the socket, the stream will return EOF.
 protected  void shutdownOutput() throws IOException 
    Disables the output stream for this socket. For a TCP socket, any previously written data will be sent followed by TCP's normal connection termination sequence. If you write to a socket output stream after invoking shutdownOutput() on the socket, the stream will throw an IOException.
 protected boolean supportsUrgentData() 
    Returns whether or not this SocketImpl supports sending urgent data. By default, false is returned unless the method is overridden in a sub-class
 public String toString() 
    Returns the address and port of this socket as a String.