Connection

Generated reference

Source file:

ansys/api/fluent/v1/connection.proto

Proto package:

ansys.api.fluent.v1.connection

Contains:

1 service, 2 messages, 1 enum

Services

---

Service: Connection

Connection service used to establish and control a client session.

Connect

Request:

ConnectRequest

Response:

stream of ConnectResponse

Connects to the server and receives streamed status responses.

Messages

---

ConnectRequest

Request sent on the Connection.Connect bidirectional stream.

request_type (1)RequestType

Requested operation.

password (2)string

Optional password for authentication.

version (3)string

Client version string.

---

ConnectRequest.RequestType (enum)

Type of request being sent on the stream.

REQUEST_TYPE_UNSPECIFIED (0)

Default value. Do not use.

REQUEST_TYPE_CONNECT (1)

Initiate a connection.

REQUEST_TYPE_PAUSE (2)

Pause the connection.

---

ConnectResponse

Response streamed from the server on Connection.Connect.

error_code (1)ConnectionError

Status code for the latest request or current session state.

Enumerations

---

ConnectionError (enum)

Connection-level error codes returned by the server.

CONNECTION_ERROR_UNSPECIFIED (0)

Default value. Do not use.

CONNECTION_ERROR_NONE (1)

The request succeeded with no error.

CONNECTION_ERROR_PASSWORD_MISMATCH (2)

The supplied password is incorrect.

CONNECTION_ERROR_MAX_CONNECTIONS_COUNT_EXCEEDED (3)

The maximum number of concurrent connections has been exceeded.

CONNECTION_ERROR_UNKNOWN (4)

An unknown or unclassified error occurred.

CONNECTION_ERROR_VERSION_MISMATCH (5)

The client/server versions are incompatible.

CONNECTION_ERROR_WAIT_TIME_EXPIRED (6)

The server wait time expired before completing the request.