SocketImpl

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> java >> [ net overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.net
Class SocketImpl

java.lang.Object
  java.net.SocketImpl

All Implemented Interfaces:: SocketOptions

Direct Known Subclasses:: PlainSocketImpl

public abstract class SocketImpl
extends java.lang.Object
implements SocketOptions

This abstract class serves as the parent class for socket implementations. The implementation class serves an intermediary to native routines that perform system specific socket operations.

A default implementation is provided by the system, but this can be changed via installing a SocketImplFactory (through a call to the static method Socket.setSocketImplFactory). A subclass of Socket can also pass in a SocketImpl to the Socket(SocketImpl) constructor to use an implementation different from the system default without installing a factory.

Field Summary

protected InetAddress address
          The address of the remote end of the socket connection

protected java.io.FileDescriptor fd
          A FileDescriptor object representing this socket connection.

protected int localport
          The port number the socket is bound to locally

protected int port
          The port number of the remote end of the socket connection

Fields inherited from interface java.net.SocketOptions

IP_MULTICAST_IF, IP_MULTICAST_IF2, IP_MULTICAST_LOOP, IP_TOS, SO_BINDADDR, SO_BROADCAST, SO_KEEPALIVE, SO_LINGER, SO_OOBINLINE, SO_RCVBUF, SO_REUSEADDR, SO_SNDBUF, SO_TIMEOUT, TCP_NODELAY

Constructor Summary

SocketImpl()
          Default, no-argument constructor for use by subclasses.

Method Summary

protected abstract void accept(SocketImpl s)
          Accepts a connection on this socket.

protected abstract int available()
          Returns the number of bytes that the caller can read from this socket without blocking.

protected abstract void bind(InetAddress host, int port)
          Binds to the specified port on the specified addr.

protected abstract void close()
          Closes the socket.

protected abstract void connect(InetAddress host, int port)
          Connects to the remote address and port specified as arguments.

protected abstract void connect(SocketAddress address, int timeout)
          Connects to the socket to the host specified in address.

protected abstract void connect(java.lang.String host, int port)
          Connects to the remote hostname and port specified as arguments.

protected abstract void create(boolean stream)
          Creates a new socket that is not bound to any local address/port and is not connected to any remote address/port.

protected java.io.FileDescriptor getFileDescriptor()
          Returns the FileDescriptor objects for this socket.

protected InetAddress getInetAddress()
          Returns the remote address this socket is connected to

protected abstract java.io.InputStream getInputStream()
          Returns an InputStream object for reading from this socket.

protected int getLocalPort()
          Returns the local port this socket is bound to

protected abstract java.io.OutputStream getOutputStream()
          Returns an OutputStream object for writing to this socket

protected int getPort()
          Returns the remote port this socket is connected to

protected abstract void listen(int backlog)
          Starts listening for connections on a socket.

protected abstract void sendUrgentData(int data)
          Sends one byte of urgent data to the socket.

protected void shutdownInput()
          Shut down the input side of this socket.

protected void shutdownOutput()
          Shut down the output side of this socket.

protected boolean supportsUrgentData()
          Returns true or false when this socket supports sending urgent data or not.

java.lang.String toString()
          Returns a String representing the remote host and port of this socket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.net.SocketOptions

getOption, setOption

Field Detail

address

protected InetAddress address

The address of the remote end of the socket connection

fd

protected java.io.FileDescriptor fd

A FileDescriptor object representing this socket connection.

localport

protected int localport

The port number the socket is bound to locally

port

protected int port

The port number of the remote end of the socket connection

Constructor Detail

SocketImpl

public SocketImpl()

Default, no-argument constructor for use by subclasses.

Method Detail

create

protected abstract void create(boolean stream)
                        throws java.io.IOException

Creates a new socket that is not bound to any local address/port and is not connected to any remote address/port. This will be created as a stream socket if the stream parameter is true, or a datagram socket if the stream parameter is false.

connect

protected abstract void connect(java.lang.String host,
                                int port)
                         throws java.io.IOException

Connects to the remote hostname and port specified as arguments.

connect

protected abstract void connect(InetAddress host,
                                int port)
                         throws java.io.IOException

Connects to the remote address and port specified as arguments.

connect

protected abstract void connect(SocketAddress address,
                                int timeout)
                         throws java.io.IOException

Connects to the socket to the host specified in address. This method blocks until successful connected or the timeout occurs. A timeout of zero means no timout.

Since:: 1.4

bind

protected abstract void bind(InetAddress host,
                             int port)
                      throws java.io.IOException

Binds to the specified port on the specified addr. Note that this addr must represent a local IP address.

Note that it is unspecified how to bind to all interfaces on the localhost (INADDR_ANY).

listen

protected abstract void listen(int backlog)
                        throws java.io.IOException

Starts listening for connections on a socket. The backlog parameter is how many pending connections will queue up waiting to be serviced before being accept'ed. If the queue of pending requests exceeds this number, additional connections will be refused.

accept

protected abstract void accept(SocketImpl s)
                        throws java.io.IOException

Accepts a connection on this socket.

getInputStream

protected abstract java.io.InputStream getInputStream()
                                               throws java.io.IOException

Returns an InputStream object for reading from this socket.

getOutputStream

protected abstract java.io.OutputStream getOutputStream()
                                                 throws java.io.IOException

Returns an OutputStream object for writing to this socket

available

protected abstract int available()
                          throws java.io.IOException

Returns the number of bytes that the caller can read from this socket without blocking.

close

protected abstract void close()
                       throws java.io.IOException

Closes the socket. This will normally cause any resources, such as the InputStream, OutputStream and associated file descriptors to be freed.

Note that if the SO_LINGER option is set on this socket, then the operation could block.

getFileDescriptor

protected java.io.FileDescriptor getFileDescriptor()

Returns the FileDescriptor objects for this socket.

getInetAddress

protected InetAddress getInetAddress()

Returns the remote address this socket is connected to

getPort

protected int getPort()

Returns the remote port this socket is connected to

supportsUrgentData

protected boolean supportsUrgentData()

Returns true or false when this socket supports sending urgent data or not.

Since:: 1.4

sendUrgentData

protected abstract void sendUrgentData(int data)
                                throws java.io.IOException

Sends one byte of urgent data to the socket.

Since:: 1.4

getLocalPort

protected int getLocalPort()

Returns the local port this socket is bound to

toString

public java.lang.String toString()

Returns a String representing the remote host and port of this socket.

shutdownInput

protected void shutdownInput()
                      throws java.io.IOException

Shut down the input side of this socket. Subsequent reads will return end-of-file.

shutdownOutput

protected void shutdownOutput()
                       throws java.io.IOException

Shut down the output side of this socket. Subsequent writes will fail with an IOException.

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> java >> [ net overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`protected InetAddress`	`address` The address of the remote end of the socket connection
`protected java.io.FileDescriptor`	`fd` A FileDescriptor object representing this socket connection.
`protected int`	`localport` The port number the socket is bound to locally
`protected int`	`port` The port number of the remote end of the socket connection

Constructor Summary
`SocketImpl()` Default, no-argument constructor for use by subclasses.

Method Summary
`protected abstract void`	`accept(SocketImpl s)` Accepts a connection on this socket.
`protected abstract int`	`available()` Returns the number of bytes that the caller can read from this socket without blocking.
`protected abstract void`	`bind(InetAddress host, int port)` Binds to the specified port on the specified addr.
`protected abstract void`	`close()` Closes the socket.
`protected abstract void`	`connect(InetAddress host, int port)` Connects to the remote address and port specified as arguments.
`protected abstract void`	`connect(SocketAddress address, int timeout)` Connects to the socket to the host specified in address.
`protected abstract void`	`connect(java.lang.String host, int port)` Connects to the remote hostname and port specified as arguments.
`protected abstract void`	`create(boolean stream)` Creates a new socket that is not bound to any local address/port and is not connected to any remote address/port.
`protected java.io.FileDescriptor`	`getFileDescriptor()` Returns the FileDescriptor objects for this socket.
`protected InetAddress`	`getInetAddress()` Returns the remote address this socket is connected to
`protected abstract java.io.InputStream`	`getInputStream()` Returns an `InputStream` object for reading from this socket.
`protected int`	`getLocalPort()` Returns the local port this socket is bound to
`protected abstract java.io.OutputStream`	`getOutputStream()` Returns an `OutputStream` object for writing to this socket
`protected int`	`getPort()` Returns the remote port this socket is connected to
`protected abstract void`	`listen(int backlog)` Starts listening for connections on a socket.
`protected abstract void`	`sendUrgentData(int data)` Sends one byte of urgent data to the socket.
`protected void`	`shutdownInput()` Shut down the input side of this socket.
`protected void`	`shutdownOutput()` Shut down the output side of this socket.
`protected boolean`	`supportsUrgentData()` Returns true or false when this socket supports sending urgent data or not.
`java.lang.String`	`toString()` Returns a `String` representing the remote host and port of this socket.

java.net Class SocketImpl

address

fd

localport

port

SocketImpl

create

connect

connect

connect

bind

listen

accept

getInputStream

getOutputStream

available

close

getFileDescriptor

getInetAddress

getPort

supportsUrgentData

sendUrgentData

getLocalPort

toString

shutdownInput

shutdownOutput

java.net
Class SocketImpl