Skip to main content

Client Functions

AMPS includes functions that return information about the currently connected client. As with the message functions, these functions return information about the client that prompted the operation, if one is present.

CLIENT_NAME​

CLIENT_NAME​


CLIENT_NAME()

Returns the name of the currently connected client.

Parameters

None.

Returns

The name of the currently connected client.

Available For​

  • Subscriptions to a topic or conflated topic.
  • Enrichment and preprocessing.
USER​

USER​


USER()

Returns the user ID of the currently connected client.

Parameters

None.

Returns

The user ID of the currently connected client.

Available For​

  • Subscriptions to a topic or conflated topic.
  • Enrichment and preprocessing.
REMOTE_ADDRESS​

REMOTE_ADDRESS​


REMOTE_ADDRESS()

Returns the remote address of the currently connected client.

Parameters

None.

Returns

The remote address of the currently connected client.

Available For​

  • Subscriptions to a topic or conflated topic.
  • Enrichment and preprocessing.
CLIENT_VERSION​

CLIENT_VERSION​


CLIENT_VERSION()

Returns the version string reported by the currently connected client.

Parameters

None.

Returns

The version string reported by the currently connected client.

Available For​

  • Subscriptions to a topic or conflated topic.
  • Enrichment and preprocessing.
CONNECTION_NAME​

CONNECTION_NAME​


CONNECTION_NAME()

Returns the connection name of the currently connected client.

Parameters

None.

Returns

The connection name of the currently connected client.

Available For​

  • Subscriptions to a topic or conflated topic.
  • Enrichment and preprocessing.