Class OpenApi
A factory interface for initiating a connection to the Open API.
Inheritance
System.Object
OpenApi
Namespace: Deephaven.OpenAPI.Client
Assembly: DeephavenOpenAPI.dll
Syntax
public static class OpenApi : object
Methods
Connect(String, Int32, IOpenApiListener)
Connect to the Open API server and return a client that can be used to login and create/attach to workers.
Declaration
public static IOpenApiClient Connect(string host, int port = 8123, IOpenApiListener openApiListener = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | host | The Open API host/IP address |
System.Int32 | port | The Open API port |
IOpenApiListener | openApiListener | An optional listener implementation |
Returns
Type | Description |
---|---|
IOpenApiClient | A new client object |