Documentation
¶
Overview ¶
Package websocket provides a types.Transport implementation using WebSockets.
Package websocket provides a types.Transport implementation using WebSockets.
Index ¶
- Variables
- func Dial(ctx context.Context, urlString string, opts types.TransportOptions) (types.Transport, error)
- func Upgrade(conn io.ReadWriter) (ws.Handshake, error)
- type WebSocketTransport
- func (t *WebSocketTransport) Close() error
- func (t *WebSocketTransport) EstablishReceiver(ctx context.Context) error
- func (t *WebSocketTransport) GetWriter() io.Writer
- func (t *WebSocketTransport) IsClosed() bool
- func (t *WebSocketTransport) LocalAddr() net.Addr
- func (t *WebSocketTransport) Receive(ctx context.Context) ([]byte, error)
- func (t *WebSocketTransport) RemoteAddr() net.Addr
- func (t *WebSocketTransport) Send(ctx context.Context, data []byte) error
- type WebSocketTransportFactory
Constants ¶
This section is empty.
Variables ¶
var DefaultDialer = ws.Dialer{}
DefaultDialer is a gobwas/ws Dialer with default options.
var DefaultHTTPUpgrader = ws.HTTPUpgrader{}
DefaultHTTPUpgrader is a gobwas/ws HTTPUpgrader with default options. Use this in your HTTP handler *before* calling the Upgrade function below.
Functions ¶
func Dial ¶
func Dial(ctx context.Context, urlString string, opts types.TransportOptions) (types.Transport, error)
Dial establishes a WebSocket connection to the given URL string and returns a WebSocketTransport. It uses the gobwas/ws Dialer.
func Upgrade ¶
func Upgrade(conn io.ReadWriter) (ws.Handshake, error)
Upgrade performs the WebSocket handshake on an existing network connection (io.ReadWriter). It's typically used on the server side after hijacking an HTTP connection. Returns the handshake information or an error. The original net.Conn should be used to create the WebSocketTransport if successful.
Types ¶
type WebSocketTransport ¶
type WebSocketTransport struct {
// contains filtered or unexported fields
}
WebSocketTransport implements the types.Transport interface using WebSockets.
func NewWebSocketTransport ¶
func NewWebSocketTransport(conn net.Conn, state ws.State, opts types.TransportOptions) *WebSocketTransport
NewWebSocketTransport creates a new WebSocketTransport.
func (*WebSocketTransport) Close ¶
func (t *WebSocketTransport) Close() error
Close terminates the transport connection.
func (*WebSocketTransport) EstablishReceiver ¶ added in v0.1.11
func (t *WebSocketTransport) EstablishReceiver(ctx context.Context) error
EstablishReceiver for WebSocketTransport does nothing, as the connection is assumed to be established before the transport is created, and reading happens within the Receive method. It exists to satisfy the Transport interface.
func (*WebSocketTransport) GetWriter ¶ added in v0.1.11
func (t *WebSocketTransport) GetWriter() io.Writer
GetWriter returns the underlying io.Writer for the WebSocket connection. Note: Writing directly to this writer bypasses WebSocket framing.
func (*WebSocketTransport) IsClosed ¶ added in v0.1.11
func (t *WebSocketTransport) IsClosed() bool
IsClosed returns true if the transport connection is closed.
func (*WebSocketTransport) LocalAddr ¶
func (t *WebSocketTransport) LocalAddr() net.Addr
LocalAddr returns the local network address.
func (*WebSocketTransport) Receive ¶
func (t *WebSocketTransport) Receive(ctx context.Context) ([]byte, error)
Receive reads the next message from the WebSocket connection.
func (*WebSocketTransport) RemoteAddr ¶
func (t *WebSocketTransport) RemoteAddr() net.Addr
RemoteAddr returns the remote network address.
type WebSocketTransportFactory ¶
type WebSocketTransportFactory struct {
Dialer ws.Dialer // gobwas Dialer
Upgrader ws.Upgrader // gobwas Upgrader (operates on io.ReadWriter)
DefaultOptions types.TransportOptions
}
WebSocketTransportFactory can be used if a factory pattern is preferred.
func NewWebSocketTransportFactory ¶
func NewWebSocketTransportFactory(opts types.TransportOptions) *WebSocketTransportFactory
NewWebSocketTransportFactory creates a factory with default dialer/upgrader.
func (*WebSocketTransportFactory) Dial ¶
func (f *WebSocketTransportFactory) Dial(ctx context.Context, urlString string) (types.Transport, error)
Dial uses the factory's dialer to establish a connection.
func (*WebSocketTransportFactory) Upgrade ¶
Upgrade uses the factory's upgrader to perform the handshake on an existing connection. The caller must provide the underlying io.ReadWriter (e.g., from hijacking an HTTP request). Returns the *same connection* wrapped in a WebSocketTransport if successful.
Source Files