Interface IOpenApiListener

An interface that clients can use to listen for callbacks from the server.

Namespace: Deephaven.OpenAPI.Client

Assembly: DeephavenOpenAPI.dll

Syntax

public interface IOpenApiListener

Methods

OnAuthTokenError(IOpenApiClient, String)

Callback invoked when the server has a token refresh error.

Declaration

void OnAuthTokenError(IOpenApiClient openApiClient, string error)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
System.String	error	Human-readable error

OnAuthTokenRefresh(IOpenApiClient, RefreshToken)

Callback invoked when the server sends a refresh token.

Declaration

void OnAuthTokenRefresh(IOpenApiClient openApiClient, RefreshToken authToken)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
Deephaven.OpenAPI.Shared.Data.RefreshToken	authToken	The refresh token

OnClosed(IOpenApiClient, UInt16, String)

Callback invoked when the server connection is closed.

Declaration

void OnClosed(IOpenApiClient openApiClient, ushort code, string reason)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
System.UInt16	code	Numeric shutdown reason code (TODO(kosak))
System.String	reason	Human-readable shutdown reason

OnError(IOpenApiClient, Exception)

Callback invoked when the server connection has an error.

Declaration

void OnError(IOpenApiClient openApiClient, Exception exception)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
Exception	exception	Connection exception

OnOpen(IOpenApiClient)

Callback invoked when the server connection has been successfully opened.

Declaration

void OnOpen(IOpenApiClient openApiClient)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client

OnPersistentQueryAdded(IOpenApiClient, IPersistentQueryConfig)

Callback invoked when a persistent query has been added.

Declaration

void OnPersistentQueryAdded(IOpenApiClient openApiClient, IPersistentQueryConfig persistentQueryConfig)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
IPersistentQueryConfig	persistentQueryConfig	The Persistent Query Config

OnPersistentQueryModified(IOpenApiClient, IPersistentQueryConfig)

Callback invoked when a persistent query has been modified.

Declaration

void OnPersistentQueryModified(IOpenApiClient openApiClient, IPersistentQueryConfig persistentQueryConfig)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
IPersistentQueryConfig	persistentQueryConfig	The Persistent Query Config

OnPersistentQueryRemoved(IOpenApiClient, IPersistentQueryConfig)

Callback invoked when a persistent query has been removed.

Declaration

void OnPersistentQueryRemoved(IOpenApiClient openApiClient, IPersistentQueryConfig persistentQueryConfig)

Parameters

Type	Name	Description
IOpenApiClient	openApiClient	The OpenAPI client
IPersistentQueryConfig	persistentQueryConfig	The Persistent Query Config