com.goldencode.p2j.util

Class SocketImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.util.SensitiveResource

com.goldencode.p2j.util.SocketImpl

All Implemented Interfaces:

CommonHandle, CommonHandleChain, Connectable, Deletable, InstantiatingProcedure, Nameable, Sensitive, Socket, SslServerAttribute, WrappedResource, Printable

public class SocketImpl
extends SensitiveResource
implements Socket, Sensitive, Connectable, SslServerAttribute

A class for implementing the SOCKET method and attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SocketImpl.ServerSocketMapping Mapping of a legacy server socket data to post-migration server socket.
private static class	SocketImpl.WorkArea Container for context-local state.

Field Summary

Fields

Modifier and Type	Field and Description
private long	bytesRead The total bytes read by the last read(com.goldencode.p2j.util.memptr, double, double) call.
private long	bytesWritten The total bytes read by the last write(com.goldencode.p2j.util.memptr, double, double) call.
private static boolean	initialized Flag indicating that the sockets were read from the directory or not.
private static ContextLocal<SocketImpl.WorkArea>	local Client side network instance for handling sockets.
private static CentralLogger	LOG Logger
private java.util.Set<java.lang.Integer>	pendingEvents A set of pending READ-RESPONSE events which were not processed by PROCESS EVENTS or a UI blocking statement.
private static InvokeConfig	READ_RESPONSE_CALL_SITE The call-site for the READ-RESPONSE event callback.
private WrappedResource	readResponseContext The context of the procedure to be executed when data is received, if any.
private java.lang.String	readResponseProcedure The name of the procedure to be executed when data is received, if any.
private static java.util.Set<SocketImpl.ServerSocketMapping>	serverSockets Set of remapped target server sockets.
private static java.lang.String	SO_KEEPALIVE SO-KEEPALIVE socket option name
private static java.lang.String	SO_LINGER SO-LINGER socket option name
private static java.lang.String	SO_RCVBUF SO-RCVBUF socket option name
private static java.lang.String	SO_RCVTIMEO SO-RCVTIMEO socket option name
private static java.lang.String	SO_REUSEADDR SO-REUSEADDR socket option name
private static java.lang.String	SO_SNDBUF SO-SNDBUF socket option name
private int	socketId The associated socket id on P2J client side.
private java.lang.String	targetHost After a connect call, this will contain the target host (-H option).
private java.lang.String	targetService After a connect call, this will contain the target service (-S option).
private static java.lang.String	TCP_NO_DELAY TCP-NODELAY socket option name
private boolean	valid Flag to track the valid state of this resource.
private boolean	valueParseError Flag indicating something went wrong during parsing of a socket option, when setSocketOption(java.lang.String, java.lang.String) is called.
private SocketImpl.WorkArea	workArea Cache the local instance.

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Fields inherited from interface com.goldencode.p2j.util.Socket

READ_AVAILABLE, READ_EXACT_NUM

Constructor Summary

Constructors

Modifier	Constructor and Description
	SocketImpl() Default constructor which initializes SOCKET specific settings.
private	SocketImpl(int socketId) Create a new socket resource on server side and associate it with the given LowLevelSocketImpl instance from P2J client side.

Method Summary

Modifier and Type	Method and Description
private boolean	asBoolean(java.lang.String val, java.lang.String option) Parse the value for the given option as a boolean.
private int	asInt(java.lang.String val, java.lang.String option) Parse the value for the given option as an int.
logical	connect(character options) Java implementation for the CONNECT() SOCKET method, this will attempt to connect to the host and port specified by the options argument.
logical	connect(java.lang.String options) Java implementation for the CONNECT() SOCKET method, this will attempt to connect to the host and port specified by the options argument.
logical	connected() Java implementation for the CONNECTED() SOCKET method, this will return true if the socket is connected or false otherwise.
static long	createSocket(int id) Create a socket resource and associate it with the given LowLevelSocketImpl instance from P2J client side.
logical	disconnect() Java implementation for the DISCONECT() SOCKET method.
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.
character	getSslServerName() Java implementation for getting the SSL-SERVER-NAME SOCKET attribute which contains the SSL server name if the connection is made as SSL.
private static void	initialize() Initialize the mappings of legacy to post-migration server socket mappings.
private void	invokeReadResponseProcedure(int eventId) Invoke the connect procedure, as data is being received by this socket.
private boolean	isConnected() Check if the java socket (from P2J client side) is still connected.
private java.util.Map<java.lang.String,java.lang.String>	parseOptions(character options) Utility method for parsing the connect(java.lang.String) parameters.
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.
int	readResponseEvent() Called by the P2J client side, it will inform the server that a server-event was generated.
private static SocketImpl.ServerSocketMapping	resolve(java.lang.String host, java.lang.Integer port, java.lang.String service) Attempt to map the given legacy server socket details to a post-migration server socket.
protected boolean	resourceDelete() Delete the resource.
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.
boolean	valid() Reports if this object is valid for use.
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.

Methods inherited from class com.goldencode.p2j.util.SensitiveResource

isSensitive, setSensitive, setSensitive, setSensitive, setSensitive

Methods inherited from class com.goldencode.p2j.util.HandleChain

_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasNextSibling, hasParent, hasPrevSibling, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name, name

Methods inherited from interface com.goldencode.p2j.util.Sensitive

isSensitive, setSensitive, setSensitive, setSensitive, setSensitive

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

LOG

private static final CentralLogger LOG

Logger

TCP_NO_DELAY

private static final java.lang.String TCP_NO_DELAY

TCP-NODELAY socket option name

See Also:

Constant Field Values

SO_LINGER

private static final java.lang.String SO_LINGER

SO-LINGER socket option name

See Also:

Constant Field Values

SO_KEEPALIVE

private static final java.lang.String SO_KEEPALIVE

SO-KEEPALIVE socket option name

See Also:

Constant Field Values

SO_REUSEADDR

private static final java.lang.String SO_REUSEADDR

SO-REUSEADDR socket option name

See Also:

Constant Field Values

SO_RCVBUF

private static final java.lang.String SO_RCVBUF

SO-RCVBUF socket option name

See Also:

Constant Field Values

SO_SNDBUF

private static final java.lang.String SO_SNDBUF

SO-SNDBUF socket option name

See Also:

Constant Field Values

SO_RCVTIMEO

private static final java.lang.String SO_RCVTIMEO

SO-RCVTIMEO socket option name

See Also:

Constant Field Values

READ_RESPONSE_CALL_SITE

private static final InvokeConfig READ_RESPONSE_CALL_SITE

The call-site for the READ-RESPONSE event callback.

local

private static final ContextLocal<SocketImpl.WorkArea> local

Client side network instance for handling sockets.

serverSockets

private static java.util.Set<SocketImpl.ServerSocketMapping> serverSockets

Set of remapped target server sockets.

initialized

private static boolean initialized

Flag indicating that the sockets were read from the directory or not.

readResponseProcedure

private java.lang.String readResponseProcedure

The name of the procedure to be executed when data is received, if any.

readResponseContext

private WrappedResource readResponseContext

The context of the procedure to be executed when data is received, if any.

pendingEvents

private final java.util.Set<java.lang.Integer> pendingEvents

A set of pending READ-RESPONSE events which were not processed by PROCESS EVENTS or a UI blocking statement. This set (and their associated events from P2J client side) is cleared when a read(com.goldencode.p2j.util.memptr, double, double) is executed.

bytesRead

private long bytesRead

The total bytes read by the last read(com.goldencode.p2j.util.memptr, double, double) call.

bytesWritten

private long bytesWritten

The total bytes read by the last write(com.goldencode.p2j.util.memptr, double, double) call.

socketId

private int socketId

The associated socket id on P2J client side. If not connected, defaults to -1.

valueParseError

private boolean valueParseError

Flag indicating something went wrong during parsing of a socket option, when setSocketOption(java.lang.String, java.lang.String) is called.

valid

private boolean valid

Flag to track the valid state of this resource.

targetHost

private java.lang.String targetHost

After a connect call, this will contain the target host (-H option).

targetService

private java.lang.String targetService

After a connect call, this will contain the target service (-S option).

workArea

private SocketImpl.WorkArea workArea

Cache the local instance.

Constructor Detail

SocketImpl

public SocketImpl()

Default constructor which initializes SOCKET specific settings.

SocketImpl

private SocketImpl(int socketId)

Create a new socket resource on server side and associate it with the given LowLevelSocketImpl instance from P2J client side.

Parameters:

socketId - The associated socket id on P2J client side.

Method Detail

createSocket

public static long createSocket(int id)

Create a socket resource and associate it with the given LowLevelSocketImpl instance from P2J client side.

Parameters:

id - The associated socket id on P2J client side.

Returns:

The ID of the newly created SocketImpl resource.

resolve

private static SocketImpl.ServerSocketMapping resolve(java.lang.String host,
                                                      java.lang.Integer port,
                                                      java.lang.String service)

Attempt to map the given legacy server socket details to a post-migration server socket.

If no mapping is found, return null.

Parameters:

host - The legacy server socket host.

port - The legacy server socket port.

service - The legacy server socket service.

Returns:

The resolved mapping or null if no mapping is possible.

initialize

private static void initialize()

Initialize the mappings of legacy to post-migration server socket mappings.

valid

public boolean valid()

Reports if this object is valid for use.

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

getLocalHost

public 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.

Specified by:

getLocalHost in interface Socket

Returns:

The address in IP form of the machine to which the Socket is connected.

getLocalPort

public 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.

Specified by:

getLocalPort in interface Socket

Returns:

The local port of the machine to which the Socket is connected.

getRemoteHost

public 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.

Specified by:

getRemoteHost in interface Socket

Returns:

The remote address in IP form of the machine to which the Socket is connected.

getRemotePort

public 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.

Specified by:

getRemotePort in interface Socket

Returns:

The remote port of the machine to which the Socket is connected.

getBytesRead

public 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.

Specified by:

getBytesRead in interface Socket

Returns:

The number of bytes read the read() method has returned from the socket.

getBytesWritten

public 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.

Specified by:

getBytesWritten in interface Socket

Returns:

The number of bytes the last write() method has put in the socket.

getSslServerName

public character getSslServerName()

Java implementation for getting the SSL-SERVER-NAME SOCKET attribute which contains the SSL server name if the connection is made as SSL.

Specified by:

getSslServerName in interface SslServerAttribute

Returns:

The SSL server name, if the connection is made as SSL or unknown otherwise

connect

public logical connect(java.lang.String options)

Java implementation for the CONNECT() SOCKET method, this will attempt to connect to the host and port specified by the options argument.

Returns true if connection succeeded, or false otherwise.

The following options can be specified as valid connect() options:

• -H host-address The host to which to connect, if not specified localhost is used.
• -S host-port The port to which to connect.
• -ssl If specified the connection will be made using ssl.
• -nosessionreuse If specified SSL session ID will not be reused when reconnecting (ssl connection only).
• -nohostverify If specified no host verification will be performed (ssl connection only).
• -pf config-file-name Specifies the file from which options will be taken.

Specified by:

connect in interface Connectable

Parameters:

options - The set of parameters for socket connection.

Returns:

true if connection succeeded, or false otherwise

connect

public logical connect(character options)

Java implementation for the CONNECT() SOCKET method, this will attempt to connect to the host and port specified by the options argument.

Returns true if connection succeeded, or false otherwise.

The following options can be specified as valid connect() options:

• -H host-address The host to which to connect, if not specified localhost is used.
• -S host-port The port to which to connect.
• -ssl If specified the connection will be negotiated to the highest level of encryption available.
• -tls Same option as -ssl, as the connection will be negotiated to the highest level of encryption available.
• -nosessionreuse If specified SSL session ID will not be reused when reconnecting (ssl connection only).
• -nohostverify If specified no host verification will be performed (ssl connection only).
• -pf config-file-name Specifies the file from which options will be taken.

Specified by:

connect in interface Connectable

Parameters:

options - The set of parameters for socket connection.

Returns:

true if connection succeeded, or false otherwise

connected

public logical connected()

Java implementation for the CONNECTED() SOCKET method, this will return true if the socket is connected or false otherwise.

Specified by:

connected in interface Connectable

Returns:

true if the socket is connected or false otherwise.

disconnect

public logical disconnect()

Java implementation for the DISCONECT() SOCKET method. This will attempt to disconnect the socket and returns true if succeeded or false otherwise.

Specified by:

disconnect in interface Connectable

Returns:

true if disconnect succeeded or false otherwise.

getSocketOption

public character getSocketOption(java.lang.String optionName)

Java implementation for the GET-SOCKET-OPTION() SOCKET method. This will return the specified socket option value.

The following options names can be used:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

getSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to retrieve.

Returns:

The specified socket option value.

getSocketOption

public character getSocketOption(character optionName)

Java implementation for the GET-SOCKET-OPTION() SOCKET method. This will return the specified socket option value.

The following options names can be used:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

getSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to retrieve.

Returns:

The specified socket option value.

getBytesAvailable

public 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.

Specified by:

getBytesAvailable in interface Socket

Returns:

The number of bytes that can be read at the current moment from the socket.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

read

public 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.

Optionally the read mode can be set by the following values:

• 1 (READ-AVAILABLE)
• 2 (READ-EXACT-NUM)

Specified by:

read in interface Socket

Parameters:

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.

Returns:

true if the read was successful or false otherwise.

write

public 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.

Specified by:

write in interface Socket

Parameters:

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.

Returns:

true if the write was successful or false otherwise.

write

public 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.

Specified by:

write in interface Socket

Parameters:

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.

Returns:

true if the write was successful or false otherwise.

write

public 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.

Specified by:

write in interface Socket

Parameters:

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.

Returns:

true if the write was successful or false otherwise.

write

public 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.

Specified by:

write in interface Socket

Parameters:

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.

Returns:

true if the write was successful or false otherwise.

setReadResponseProcedure

public logical setReadResponseProcedure(java.lang.String procedureName)

Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method. This will set the procedure to execute when a READ-RESPONSE event is received.

Specified by:

setReadResponseProcedure in interface Socket

Parameters:

procedureName - The name of the procedure to be executed on READ-RESPONSE event.

Returns:

true if the operation was successful or false otherwise.

setReadResponseProcedure

public logical setReadResponseProcedure(character procedureName)

Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method. This will set the procedure to execute when a READ-RESPONSE event is received.

Specified by:

setReadResponseProcedure in interface Socket

Parameters:

procedureName - The name of the procedure to be executed on READ-RESPONSE event.

Returns:

true if the operation was successful or false otherwise.

setReadResponseProcedure

public logical setReadResponseProcedure(java.lang.String procedureName,
                                        handle procHandle)

Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method. This will set the procedure to execute when a READ-RESPONSE event is received.

Specified by:

setReadResponseProcedure in interface Socket

Parameters:

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.

Returns:

true if the operation was successful or false otherwise.

setReadResponseProcedure

public logical setReadResponseProcedure(character procedureName,
                                        handle procHandle)

Java implementation for the SET-READ-RESPONSE-PROCEDURE() SOCKET method. This will set the procedure to execute when a READ-RESPONSE event is received.

Specified by:

setReadResponseProcedure in interface Socket

Parameters:

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.

Returns:

true if the operation was successful or false otherwise.

setSocketOption

public logical setSocketOption(java.lang.String optionName,
                               java.lang.String optionVal)

Java implementation for the SET-SOCKET-OPTION method. This will set the value for the specified option.

The following options are available:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

setSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to set.

optionVal - The value of the option we want to set

Returns:

true if the operation was successful or false otherwise.

setSocketOption

public logical setSocketOption(character optionName,
                               java.lang.String optionVal)

Java implementation for the SET-SOCKET-OPTION method. This will set the value for the specified option.

The following options are available:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

setSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to set.

optionVal - The value of the option we want to set

Returns:

true if the operation was successful or false otherwise.

setSocketOption

public logical setSocketOption(java.lang.String optionName,
                               character optionVal)

Java implementation for the SET-SOCKET-OPTION method. This will set the value for the specified option.

The following options are available:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

setSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to set.

optionVal - The value of the option we want to set

Returns:

true if the operation was successful or false otherwise.

setSocketOption

public logical setSocketOption(character optionName,
                               character optionVal)

Java implementation for the SET-SOCKET-OPTION method. This will set the value for the specified option.

The following options are available:

• TCP-NODELAY
• SO-LINGER
• SO-KEEPALIVE
• SO-REUSEADDR
• SO-RCVBUF
• SO-SNDBUF
• SO-RCVTIMEO

Specified by:

setSocketOption in interface Socket

Parameters:

optionName - The name of the socket option we want to set.

optionVal - The value of the option we want to set

Returns:

true if the operation was successful or false otherwise.

readResponseEvent

public int readResponseEvent()

Called by the P2J client side, it will inform the server that a server-event was generated. Although the event originates from the P2J Client Side, socket events are server-side events.

Returns:

The ID of the generated server event or -1 if a event could not be posted (i.e. the resource is not SENSITIVE).

resourceDelete

protected boolean resourceDelete()

Delete the resource.

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

isConnected

private boolean isConnected()

Check if the java socket (from P2J client side) is still connected.

Returns:

See above.

invokeReadResponseProcedure

private void invokeReadResponseProcedure(int eventId)

Invoke the connect procedure, as data is being received by this socket. If readResponseProcedure is unknown, this is a no-op.

This will also remove the server event from the list of pendingEvents.

Parameters:

eventId - The ID of the server event being executed.

asInt

private int asInt(java.lang.String val,
                  java.lang.String option)

Parse the value for the given option as an int. If it can not be parsed, show an error.

Parameters:

val - The value to be parsed.

option - The option name.

Returns:

The value as an int.

asBoolean

private boolean asBoolean(java.lang.String val,
                          java.lang.String option)

Parse the value for the given option as a boolean. If it can not be parsed, show an error. Note that the value must be one of TRUE or FALSE values (case insensitive) for the value to be treated as a boolean.

Parameters:

val - The value to be parsed.

option - The option name.

Returns:

The value as a boolean.

parseOptions

private java.util.Map<java.lang.String,java.lang.String> parseOptions(character options)

Utility method for parsing the connect(java.lang.String) parameters.

Parameters:

options - The string to parse.

Returns:

The parameter-to-value map or null if something could not be parsed.