SocketImpl
abstract class SocketImpl : SocketOptions
kotlin.Any | |
↳ | java.net.SocketImpl |
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.
Summary
Inherited constants | |
---|---|
Public constructors | |
---|---|
Public methods | |
---|---|
open String |
toString() Returns the address and port of this socket as a |
Protected methods | |
---|---|
abstract Unit |
accept(s: SocketImpl!) Accepts a connection. |
abstract Int |
Returns the number of bytes that can be read from this socket without blocking. |
abstract Unit |
bind(host: InetAddress!, port: Int) Binds this socket to the specified local IP address and port number. |
abstract Unit |
close() Closes this socket. |
abstract Unit |
Connects this socket to the specified port on the named host. |
abstract Unit |
connect(address: InetAddress!, port: Int) Connects this socket to the specified port number on the specified host. |
abstract Unit |
connect(address: SocketAddress!, timeout: Int) Connects this socket to the specified port number on the specified host. |
abstract Unit |
Creates either a stream or a datagram socket. |
open FileDescriptor! |
Returns the value of this socket's |
open InetAddress! |
Returns the value of this socket's |
abstract InputStream! |
Returns an input stream for this socket. |
open Int |
Returns the value of this socket's |
open T |
getOption(name: SocketOption<T>!) Called to get a socket option. |
abstract OutputStream! |
Returns an output stream for this socket. |
open Int |
getPort() Returns the value of this socket's |
abstract Unit |
Sets the maximum queue length for incoming connection indications (a request to connect) to the |
abstract Unit |
sendUrgentData(data: Int) Send one byte of urgent data on the socket. |
open Unit |
setOption(name: SocketOption<T>!, value: T) Called to set a socket option. |
open Unit |
setPerformancePreferences(connectionTime: Int, latency: Int, bandwidth: Int) Sets performance preferences for this socket. |
open Unit |
Places the input stream for this socket at "end of stream". |
open Unit |
Disables the output stream for this socket. |
open MutableSet<SocketOption<*>!>! |
Returns a set of SocketOptions supported by this impl and by this impl's socket (Socket or ServerSocket) |
open Boolean |
Returns whether or not this SocketImpl supports sending urgent data. |
Inherited functions | |
---|---|
Properties | |
---|---|
InetAddress! |
The IP address of the remote end of this socket. |
FileDescriptor! |
The file descriptor object for this socket. |
Int |
The local port number to which this socket is connected. |
Int |
The port number on the remote host to which this socket is connected. |
Public constructors
Public methods
toString
open fun toString(): String
Returns the address and port of this socket as a String
.
Return | |
---|---|
String |
a string representation of this socket. |
Protected methods
accept
protected abstract fun accept(s: SocketImpl!): Unit
Accepts a connection.
Parameters | |
---|---|
s |
SocketImpl!: the accepted connection. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when accepting the connection. |
available
protected abstract fun available(): Int
Returns the number of bytes that can be read from this socket without blocking.
Return | |
---|---|
Int |
the number of bytes that can be read from this socket without blocking. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when determining the number of bytes available. |
bind
protected abstract fun bind(
host: InetAddress!,
port: Int
): Unit
Binds this socket to the specified local IP address and port number.
Parameters | |
---|---|
host |
InetAddress!: an IP address that belongs to a local interface. |
port |
Int: the port number. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when binding this socket. |
close
protected abstract fun close(): Unit
Closes this socket.
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when closing this socket. |
connect
protected abstract fun connect(
host: String!,
port: Int
): Unit
Connects this socket to the specified port on the named host.
Parameters | |
---|---|
host |
String!: the name of the remote host. |
port |
Int: the port number. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when connecting to the remote host. |
connect
protected abstract fun connect(
address: InetAddress!,
port: Int
): Unit
Connects this socket to the specified port number on the specified host.
Parameters | |
---|---|
address |
InetAddress!: the IP address of the remote host. |
port |
Int: the port number. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when attempting a connection. |
connect
protected abstract fun connect(
address: SocketAddress!,
timeout: Int
): Unit
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.
Parameters | |
---|---|
address |
SocketAddress!: the Socket address of the remote host. |
timeout |
Int: the timeout value, in milliseconds, or zero for no timeout. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when attempting a connection. |
create
protected abstract fun create(stream: Boolean): Unit
Creates either a stream or a datagram socket.
Parameters | |
---|---|
stream |
Boolean: if true , create a stream socket; otherwise, create a datagram socket. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs while creating the socket. |
getFileDescriptor
protected open fun getFileDescriptor(): FileDescriptor!
Returns the value of this socket's fd
field.
Return | |
---|---|
FileDescriptor! |
the value of this socket's fd field. |
See Also
getInetAddress
protected open fun getInetAddress(): InetAddress!
Returns the value of this socket's address
field.
Return | |
---|---|
InetAddress! |
the value of this socket's address field. |
See Also
getInputStream
protected abstract fun getInputStream(): InputStream!
Returns an input stream for this socket.
Return | |
---|---|
InputStream! |
a stream for reading from this socket. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when creating the input stream. |
getLocalPort
protected open fun getLocalPort(): Int
Returns the value of this socket's localport
field.
Return | |
---|---|
Int |
the value of this socket's localport field. |
See Also
getOption
protected open fun <T : Any!> getOption(name: SocketOption<T>!): T
Called to get a socket option.
Parameters | |
---|---|
<T> |
The type of the socket option value |
name |
SocketOption<T>!: The socket option |
Return | |
---|---|
T |
the value of the named option |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if the SocketImpl does not support the option. |
java.io.IOException |
if an I/O error occurs, or if the socket is closed. |
getOutputStream
protected abstract fun getOutputStream(): OutputStream!
Returns an output stream for this socket.
Return | |
---|---|
OutputStream! |
an output stream for writing to this socket. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when creating the output stream. |
getPort
protected open fun getPort(): Int
Returns the value of this socket's port
field.
Return | |
---|---|
Int |
the value of this socket's port field. |
See Also
listen
protected abstract fun listen(backlog: Int): Unit
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.
Parameters | |
---|---|
backlog |
Int: the maximum length of the queue. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when creating the queue. |
sendUrgentData
protected abstract fun sendUrgentData(data: Int): Unit
Send one byte of urgent data on the socket. The byte to be sent is the low eight bits of the parameter
Parameters | |
---|---|
data |
Int: The byte of data to send |
Exceptions | |
---|---|
java.io.IOException |
if there is an error sending the data. |
setOption
protected open fun <T : Any!> setOption(
name: SocketOption<T>!,
value: T
): Unit
Called to set a socket option.
Parameters | |
---|---|
<T> |
The type of the socket option value |
name |
SocketOption<T>!: The socket option |
value |
T: The value of the socket option. A value of null may be valid for some options. |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if the SocketImpl does not support the option |
java.io.IOException |
if an I/O error occurs, or if the socket is closed. |
setPerformancePreferences
protected open fun setPerformancePreferences(
connectionTime: Int,
latency: Int,
bandwidth: Int
): Unit
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 sub-class.
Parameters | |
---|---|
connectionTime |
Int: An int expressing the relative importance of a short connection time |
latency |
Int: An int expressing the relative importance of low latency |
bandwidth |
Int: An int expressing the relative importance of high bandwidth |
shutdownInput
protected open fun shutdownInput(): Unit
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 this method on the socket, the stream's available
method will return 0, and its read
methods will return -1
(end of stream).
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when shutting down this socket. |
shutdownOutput
protected open fun shutdownOutput(): Unit
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.
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs when shutting down this socket. |
supportedOptions
protected open fun supportedOptions(): MutableSet<SocketOption<*>!>!
Returns a set of SocketOptions supported by this impl and by this impl's socket (Socket or ServerSocket)
Return | |
---|---|
MutableSet<SocketOption<*>!>! |
a Set of SocketOptions |
supportsUrgentData
protected open fun supportsUrgentData(): Boolean
Returns whether or not this SocketImpl supports sending urgent data. By default, false is returned unless the method is overridden in a sub-class
Return | |
---|---|
Boolean |
true if urgent data supported |
See Also
Properties
address
protected var address: InetAddress!
The IP address of the remote end of this socket.
fd
protected var fd: FileDescriptor!
The file descriptor object for this socket.
localport
protected var localport: Int
The local port number to which this socket is connected.
port
protected var port: Int
The port number on the remote host to which this socket is connected.