File	Doc	Category	Size	Date	Package
SocketImpl.java	API Doc	Android 1.5 API	14513	Wed May 06 22:41:04 BST 2009	java.net

SocketImpl

• java.lang.Object

Fields Summary
protected InetAddress	address The remote address this socket is connected to.
protected int	port The remote port this socket is connected to.
protected FileDescriptor	fd The file descriptor of this socket.
protected int	localport The local port this socket is connected to.
org.apache.harmony.luni.platform.INetworkSystem	netImpl
boolean	streaming
boolean	shutdownInput

Constructors Summary
public SocketImpl() Creates a new connection-oriented socket implementation. see SocketImplFactory since Android 1.0 this.netImpl = Platform.getNetworkSystem();

Methods Summary
protected abstract void	accept(java.net.SocketImpl newSocket) Waits for an incoming request and blocks until the connection is opened on the given socket. param newSocket the socket to accept connections on. throws IOException if an error occurs while accepting a new connection. since Android 1.0
protected abstract int	available() Returns the available number of bytes which are readable from this socket without blocking. return the number of bytes that may be read without blocking. throws IOException if an error occurs while reading the number of bytes. since Android 1.0
protected abstract void	bind(java.net.InetAddress address, int port) Binds this socket to the specified local host address and port number. param address the local machine address to bind this socket to. param port the port on the local machine to bind this socket to. throws IOException if an error occurs while binding this socket. since Android 1.0
protected abstract void	close() Closes this socket. This makes later access invalid. throws IOException if an error occurs while closing this socket. since Android 1.0
protected abstract void	connect(java.net.SocketAddress remoteAddr, int timeout) Connects this socket to the remote host address and port number specified by the {@code SocketAddress} object with the given timeout. This method will block indefinitely if the timeout is set to zero. param remoteAddr the remote host address and port number to connect to. param timeout the timeout value in milliseconds. throws IOException if an error occurs while connecting. since Android 1.0
protected abstract void	connect(java.lang.String host, int port) Connects this socket to the specified remote host and port number. param host the remote host this socket has to be connected to. param port the remote port on which this socket has to be connected. throws IOException if an error occurs while connecting to the remote host. since Android 1.0
protected abstract void	connect(java.net.InetAddress address, int port) Connects this socket to the specified remote host address and port number. param address the remote host address this socket has to be connected to. param port the remote port on which this socket has to be connected. throws IOException if an error occurs while connecting to the remote host. since Android 1.0
protected abstract void	create(boolean isStreaming) Creates a new unconnected socket. The argument {@code isStreaming} defines whether the new socket is a streaming or a datagram socket. param isStreaming defines whether the type of the new socket is streaming or datagram. throws IOException if an error occurs while creating the socket. since Android 1.0
protected java.io.FileDescriptor	getFileDescriptor() Gets the file descriptor of this socket. return the file descriptor of this socket. since Android 1.0 return fd;
protected java.net.InetAddress	getInetAddress() Gets the remote address this socket is connected to. return the remote address of this socket. since Android 1.0 return address;
protected abstract java.io.InputStream	getInputStream() Gets the input stream of this socket. return the input stream of this socket. throws IOException if an error occurs while accessing the input stream. since Android 1.0
protected int	getLocalPort() Gets the local port number of this socket. The field is initialized to {@code -1} and upon demand will go to the IP stack to get the bound value. See the class comment for the context of the local port. return the local port number this socket is bound to. since Android 1.0 return localport;
public abstract java.lang.Object	getOption(int optID) Gets the value of the given socket option. param optID the socket option to retrieve. return the option value. throws SocketException if an error occurs while accessing the option. since Android 1.0
protected abstract java.io.OutputStream	getOutputStream() Gets the output stream of this socket. return the output stream of this socket. throws IOException if an error occurs while accessing the output stream. since Android 1.0
protected int	getPort() Gets the remote port number of this socket. This value is not meaningful when this instance is wrapped by a {@code ServerSocket}. return the remote port this socket is connected to. since Android 1.0 return port;
protected abstract void	listen(int backlog) Listens for connection requests on this streaming socket. Incoming connection requests are queued up to the limit specified by {@code backlog}. Additional requests are rejected. The method {@code listen()} may only be invoked on streaming sockets. param backlog the maximum number of outstanding connection requests. throws IOException if an error occurs while listening. since Android 1.0
int	read(byte[] buffer, int offset, int count) In the IP stack, read at most {@code count} bytes off the socket into the {@code buffer}, at the {@code offset}. If the timeout is zero, block indefinitely waiting for data, otherwise wait the specified period (in milliseconds). param buffer the buffer to read into param offset the offset into the buffer param count the max number of bytes to read return int the actual number of bytes read exception IOException thrown if an error occurs while reading if (shutdownInput) { return -1; } try { // BEGIN android-added int receiveTimeout = (Integer)getOption(SocketOptions.SO_TIMEOUT); // END android-added int read = this.netImpl.receiveStream(fd, buffer, offset, count, receiveTimeout); if (read == -1) { shutdownInput = true; } return read; } catch (InterruptedIOException e) { throw new SocketTimeoutException(e.getMessage()); }
protected abstract void	sendUrgentData(int value) Sends the single byte of urgent data on the socket. param value the byte of urgent data. throws IOException if an error occurs sending urgent data. since Android 1.0
public abstract void	setOption(int optID, java.lang.Object val) Sets the value for the specified socket option. param optID the socket option to be set. param val the option value. throws SocketException if an error occurs while setting the option. since Android 1.0
protected void	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets performance preference for connection time, latency and bandwidth. Does nothing by default. param connectionTime the importance of connect time. param latency the importance of latency. param bandwidth the importance of bandwidth. since Android 1.0 // Our socket implementation only provide one protocol: TCP/IP, so // we do nothing for this method
protected void	shutdownInput() Closes the input channel of this socket. This default implementation always throws an {@link IOException} to indicate that the subclass should have overridden this method. throws IOException always because this method should be overridden. since Android 1.0 // KA025=Method has not been implemented throw new IOException(Msg.getString("KA025"));//$NON-NLS-1$
protected void	shutdownOutput() Closes the output channel of this socket. This default implementation always throws an {@link IOException} to indicate that the subclass should have overridden this method. throws IOException always because this method should be overridden. since Android 1.0 // KA025=Method has not been implemented throw new IOException(Msg.getString("KA025"));//$NON-NLS-1$
protected boolean	supportsUrgentData() Returns whether the socket supports urgent data or not. Subclasses should override this method. return {@code false} because subclasses must override this method. since Android 1.0 return false;
public java.lang.String	toString() Returns a string containing a concise, human-readable description of the socket. return the textual representation of this socket. since Android 1.0 return new StringBuffer(100).append("Socket[addr=").append( getInetAddress()).append(",port=").append(port).append( ",localport=").append(getLocalPort()).append("]").toString();
int	write(byte[] buffer, int offset, int count) In the IP stack, write at most {@code count} bytes on the socket from the {@code buffer}, from the {@code offset}. param buffer the buffer to read into param offset the offset into the buffer param count the number of bytes to write return int the actual number of bytes written exception IOException thrown if an error occurs while writing if (!streaming) { // BEGIN android-changed // copied from newer harmony version return this.netImpl .sendDatagram2(fd, buffer, offset, count, port, address); // END android-changed } return this.netImpl.sendStream(fd, buffer, offset, count);