Transaction System API

ClientSocket

Provides functionality for working with browser WebSockets.

Method Summary
String getChannel()

Returns the channel associated with this socket.

String getEndpoint()

Returns the endpoint for connecting this ClientSocket.

String getId()

Returns the ID used for retrieving this ClientSocket.

Date getLastAccess()

Returns the last time this was accessed

int getMessageCount()

Returns the number of messages from the client

String getWorker()

Returns the worker that created this socket which may not be the same as the worker running background jobs.

  sendMessage(String message)

Sends a message to the socket. Requires the socket to be registered with the client first through the endpoint.

String toString()

Returns a description of this object.

Method Detail


String getChannel()

Returns the channel associated with this socket.

Returns:  String

Since: 06-04-2026

top

String getEndpoint()

Returns the endpoint for connecting this ClientSocket.

Returns:  String

Since: 06-04-2026

top

String getId()

Returns the ID used for retrieving this ClientSocket.

Returns:  String

Since: 06-04-2026

top

Date getLastAccess()

Returns the last time this was accessed

Returns:  Date

Since: 06-04-2026

top

int getMessageCount()

Returns the number of messages from the client

Returns:  int

Since: 06-04-2026

top

String getWorker()

Returns the worker that created this socket which may not be the same as the worker running background jobs.

Returns:  String

Since: 06-04-2026

top

sendMessage(String message)

Sends a message to the socket. Requires the socket to be registered with the client first through the endpoint.

Parameters:

  • String   message

Since: 06-04-2026

top

String toString()

Returns a description of this object.

Returns:  String

Since: 06-04-2026

top
Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. API Date: Jun 06, 2026 03:29 PM