public interface Socket extends CommonHandleChain
Exposes the following Attributes and methods:
handle.unwrapSocket()
API, which, will return a
SocketImpl
for a Socket type handle.Modifier and Type | Field and Description |
---|---|
static int |
READ_AVAILABLE
Constant defining socket read mode: READ-AVAILABLE
|
static int |
READ_EXACT_NUM
Constant for socket read mode: READ-EXACT-NUM
|
Modifier and Type | Method and Description |
---|---|
integer |
getBytesAvailable()
Java implementation for the GET-BYTES-AVAILABLE() SOCKET method, this will return the number
of bytes that can be read at the current moment from the socket.
|
integer |
getBytesRead()
Java implementation for getting the BYTES-READ SOCKET attribute which contains the number
of bytes the last read() method call returned from the socket.
|
integer |
getBytesWritten()
Java implementation for getting the BYTES-WRITTEN SOCKET attribute which contains the
number of bytes the last write() method has put in the socket.
|
character |
getLocalHost()
Java implementation for getting the LOCAL-HOST SOCKET attribute which contains the address
in IP form of the machine to which the Socket is connected.
|
integer |
getLocalPort()
Java implementation for getting the LOCAL-PORT SOCKET attribute which contains the local
port of the machine to which the Socket is connected.
|
character |
getRemoteHost()
Java implementation for getting the REMOTE-HOST SOCKET attribute which contains the address
in IP form of the machine to which the Socket is connected.
|
integer |
getRemotePort()
Java implementation for getting the REMOTE-PORT SOCKET attribute which contains the local
port of the machine to which the Socket is connected.
|
character |
getSocketOption(character optionName)
Java implementation for the GET-SOCKET-OPTION() SOCKET method.
|
character |
getSocketOption(java.lang.String optionName)
Java implementation for the GET-SOCKET-OPTION() SOCKET method.
|
logical |
read(memptr buffer,
double pos,
double len)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
double pos,
double len,
double mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
double pos,
double len,
NumberType mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
double pos,
NumberType len)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
double pos,
NumberType len,
double mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
double pos,
NumberType len,
NumberType mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
double len)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
double len,
double mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
double len,
NumberType mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
NumberType len)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
NumberType len,
double mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
read(memptr buffer,
NumberType pos,
NumberType len,
NumberType mode)
Java implementation for the READ() SOCKET method, this will read the specified number of
bytes from the available data on the socket, and put it inside the memory buffer
argument at the specified position.
|
logical |
setReadResponseProcedure(character procedureName)
Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method.
|
logical |
setReadResponseProcedure(character procedureName,
handle procHandle)
Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method.
|
logical |
setReadResponseProcedure(java.lang.String procedureName)
Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method.
|
logical |
setReadResponseProcedure(java.lang.String procedureName,
handle procHandle)
Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method.
|
logical |
setSocketOption(character optionName,
character optionVal)
Java implementation for the SET-SOCKET-OPTION method.
|
logical |
setSocketOption(character optionName,
java.lang.String optionVal)
Java implementation for the SET-SOCKET-OPTION method.
|
logical |
setSocketOption(java.lang.String optionName,
character optionVal)
Java implementation for the SET-SOCKET-OPTION method.
|
logical |
setSocketOption(java.lang.String optionName,
java.lang.String optionVal)
Java implementation for the SET-SOCKET-OPTION method.
|
logical |
write(memptr buffer,
double pos,
double len)
Java implementation for the WRITE() SOCKET method, this will write data from the specified
buffer location (position and number of bytes) to the socket.
|
logical |
write(memptr buffer,
double pos,
NumberType len)
Java implementation for the WRITE() SOCKET method, this will write data from the specified
buffer location (position and number of bytes) to the socket.
|
logical |
write(memptr buffer,
NumberType pos,
double len)
Java implementation for the WRITE() SOCKET method, this will write data from the specified
buffer location (position and number of bytes) to the socket.
|
logical |
write(memptr buffer,
NumberType pos,
NumberType len)
Java implementation for the WRITE() SOCKET method, this will write data from the specified
buffer location (position and number of bytes) to the socket.
|
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData
getResourceType, readOnlyError
id, id, unknown, valid
static final int READ_AVAILABLE
static final int READ_EXACT_NUM
character getLocalHost()
integer getLocalPort()
character getRemoteHost()
integer getRemotePort()
integer getBytesRead()
integer getBytesWritten()
character getSocketOption(character optionName)
The following options names can be used:
optionName
- The name of the socket option we want to retrieve.character getSocketOption(java.lang.String optionName)
The following options names can be used:
optionName
- The name of the socket option we want to retrieve.integer getBytesAvailable()
logical read(memptr buffer, double pos, double len)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, double len)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.true
if the read was successful or false
otherwise.logical read(memptr buffer, double pos, NumberType len)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, NumberType len)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.true
if the read was successful or false
otherwise.logical read(memptr buffer, double pos, double len, double mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, double len, double mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, double pos, NumberType len, double mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, NumberType len, double mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, double pos, double len, NumberType mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, double len, NumberType mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, double pos, NumberType len, NumberType mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical read(memptr buffer, NumberType pos, NumberType len, NumberType mode)
Optionally the read mode can be set by the following values:
buffer
- The memory buffer where read() puts the data.pos
- The position in the memory buffer where the data is added.len
- The number of bytes to read from the socket.mode
- The mode to set for the reading operation.true
if the read was successful or false
otherwise.logical write(memptr buffer, double pos, double len)
buffer
- The memory buffer from which the data will be written to the socket.pos
- The position in the memory buffer from where the data to be taken starts.len
- The number of bytes to take from the memory buffer.true
if the write was successful or false
otherwise.logical write(memptr buffer, NumberType pos, double len)
buffer
- The memory buffer from which the data will be written to the socket.pos
- The position in the memory buffer from where the data to be taken starts.len
- The number of bytes to take from the memory buffer.true
if the write was successful or false
otherwise.logical write(memptr buffer, double pos, NumberType len)
buffer
- The memory buffer from which the data will be written to the socket.pos
- The position in the memory buffer from where the data to be taken starts.len
- The number of bytes to take from the memory buffer.true
if the write was successful or false
otherwise.logical write(memptr buffer, NumberType pos, NumberType len)
buffer
- The memory buffer from which the data will be written to the socket.pos
- The position in the memory buffer from where the data to be taken starts.len
- The number of bytes to take from the memory buffer.true
if the write was successful or false
otherwise.logical setReadResponseProcedure(java.lang.String procedureName)
procedureName
- The name of the procedure to be executed on READ-RESPONSE event.true
if the operation was successful or false
otherwise.logical setReadResponseProcedure(character procedureName)
procedureName
- The name of the procedure to be executed on READ-RESPONSE event.true
if the operation was successful or false
otherwise.logical setReadResponseProcedure(java.lang.String procedureName, handle procHandle)
procedureName
- The name of the procedure to be executed on READ-RESPONSE event.procHandle
- The context where the specified procedure belongs. Validation will be performed
when the READ-RESPONSE event is executed.true
if the operation was successful or false
otherwise.logical setReadResponseProcedure(character procedureName, handle procHandle)
procedureName
- The name of the procedure to be executed on READ-RESPONSE event.procHandle
- The context where the specified procedure belongs. Validation will be performed
when the READ-RESPONSE event is executed.true
if the operation was successful or false
otherwise.logical setSocketOption(java.lang.String optionName, java.lang.String optionVal)
The following options are available:
optionName
- The name of the socket option we want to set.optionVal
- The value of the option we want to settrue
if the operation was successful or false
otherwise.logical setSocketOption(character optionName, java.lang.String optionVal)
The following options are available:
optionName
- The name of the socket option we want to set.optionVal
- The value of the option we want to settrue
if the operation was successful or false
otherwise.logical setSocketOption(java.lang.String optionName, character optionVal)
The following options are available:
optionName
- The name of the socket option we want to set.optionVal
- The value of the option we want to settrue
if the operation was successful or false
otherwise.logical setSocketOption(character optionName, character optionVal)
The following options are available:
optionName
- The name of the socket option we want to set.optionVal
- The value of the option we want to settrue
if the operation was successful or false
otherwise.