nhooyr

func (*NhooyrWebsocketConnectionAdapter) Close ¶

func (adapter *NhooyrWebsocketConnectionAdapter) Close(ctx context.Context, code wsadapters.StatusCode, reason string) error

Description ¶

Send a close message with the provided status code and an optional close reason and drop the websocket connection.

Inputs ¶

• ctx: Context used for tracing purpose
• code: Status code to use in close message
• reason: Optional reason joined in clsoe message. Can be empty.

Returns ¶

• nil in case of success
• error: server unreachable, connection already closed, ...

func (*NhooyrWebsocketConnectionAdapter) Dial ¶

func (adapter *NhooyrWebsocketConnectionAdapter) Dial(ctx context.Context, target url.URL) (*http.Response, error)

Description ¶

Dial opens a connection to the websocket server and performs a WebSocket handshake.

Inputs ¶

• ctx: Context used for tracing/timeout purpose
• target: Target server URL

Returns ¶

The server response to websocket handshake or an error if any.

func (*NhooyrWebsocketConnectionAdapter) GetUnderlyingWebsocketConnection ¶

func (adapter *NhooyrWebsocketConnectionAdapter) GetUnderlyingWebsocketConnection() any

Description ¶

Return the underlying websocket connection if any. Returned value has to be type asserted.

Returns ¶

The underlying websocket connection if any. Returned value has to be type asserted.

func (*NhooyrWebsocketConnectionAdapter) Ping ¶

func (adapter *NhooyrWebsocketConnectionAdapter) Ping(ctx context.Context) error

Description ¶

Send a Ping message to the websocket server and blocks until a Pong response is received, a timeout occurs or until connection is closed.

A concrrent gorotine must call Read method so that contorl frames, pong inclded, are processed and ping does not hang.

Inputs ¶

• ctx: context used for tracing/timeout purpose.

Returns ¶

- nil in case of success: if a Ping message is sent to the server and if a Pong is received. - error: connection is closed, context timeout/cancellation, ...

func (*NhooyrWebsocketConnectionAdapter) Read ¶

func (adapter *NhooyrWebsocketConnectionAdapter) Read(ctx context.Context) (wsadapters.MessageType, []byte, error)

Description ¶

Read a single message from the websocket server. Read blocks until a message is received from the server or until connection closes

Inputs ¶

• ctx: Context used for tracing purpose

Returns ¶

• MessageType: received message type (Binary | Text)
• []bytes: Message content
• error: in case of connection closure, context timeout/cancellation or failure.

func (*NhooyrWebsocketConnectionAdapter) Write ¶

func (adapter *NhooyrWebsocketConnectionAdapter) Write(ctx context.Context, msgType wsadapters.MessageType, msg []byte) error

Description ¶

Write a single message to the websocket server. Write blocks until message is sent to the server or until an error occurs: context timeout, cancellation, connection closed, ....

Inputs ¶

• ctx: Context used for tracing/timeout purpose
• MessageType: received message type (Binary | Text)
• []bytes: Message content

Returns ¶

• error: in case of connection closure, context timeout/cancellation or failure.