connection

Documentation

Overview

Package connection provides utilities for the connection used when bridging TCP over websocket.

Index

• Constants
• func DialWebsocket(ctx context.Context, backendURL *url.URL, h http.Header) (net.Conn, error)
• func Handler(backendPort int, passthroughHandler http.Handler) http.Handler
• type WebsocketNetConn
  • func (c *WebsocketNetConn) Read(bs []byte) (count int, err error)
  • func (c *WebsocketNetConn) SetDeadline(t time.Time) error
  • func (c *WebsocketNetConn) Write(bs []byte) (count int, err error)

Constants

const StreamingPath = "/tcp-over-websocket-bridge/35218cb7-1201-4940-89e8-48d8f03fed96"

StreamingPath is the path used for websocket channels that implement the bridge.

The last component of the path is a randomly generated UUID used to reduce the risk of accidental conflicts.

Functions

func DialWebsocket

func DialWebsocket(ctx context.Context, backendURL *url.URL, h http.Header) (net.Conn, error)

DialWebsocket establishes a connection with the given server using websocket as the underlying transport layer.

func Handler

func Handler(backendPort int, passthroughHandler http.Handler) http.Handler

Handler returns an HTTP handler that forwards bridged TCP connections to the given port.

The passthroughHandler is used to forward any requests that are not part of the TCP-Over-WS bridge.

Types

type WebsocketNetConn

type WebsocketNetConn struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

WebsocketNetConnection wraps the websocket.Conn type and adds extends it to implement the net.Conn interface

func (*WebsocketNetConn) Read

func (c *WebsocketNetConn) Read(bs []byte) (count int, err error)

Read implements the io.Reader interface.

func (*WebsocketNetConn) SetDeadline

func (c *WebsocketNetConn) SetDeadline(t time.Time) error

SetDeadline implements the net.Conn interface.

func (*WebsocketNetConn) Write

func (c *WebsocketNetConn) Write(bs []byte) (count int, err error)

Write implements the io.Writer interface.