transport

Documentation

Index

• type ChannelBindingMechanism
• type Transport
  • func NewSocketTransport(conn net.Conn, keepAlive int) Transport
  • func NewWebSocketTransport(conn WebSocketConn, keepAlive int) Transport
• type TransportType
  • func (tt TransportType) String() string
• type WebSocketConn

Types

type ChannelBindingMechanism

type ChannelBindingMechanism int

ChannelBindingMechanism represents a scram channel binding mechanism.

const (
	// TLSUnique represents 'tls-unique' channel binding mechanism.
	TLSUnique ChannelBindingMechanism = iota
)

type Transport

type Transport interface {
	io.ReadCloser

	// WriteString writes a raw string to the transport.
	WriteString(string) error

	// WriteElement writes an element to the transport
	// serializing it to it's XML representation.
	WriteElement(elem xml.XElement, includeClosing bool) error

	// StartTLS secures the transport using SSL/TLS
	StartTLS(*tls.Config)

	// EnableCompression activates a compression
	// mechanism on the transport.
	EnableCompression(compress.Level)

	// ChannelBindingBytes returns current transport
	// channel binding bytes.
	ChannelBindingBytes(ChannelBindingMechanism) []byte
}

Transport represents a stream transport mechanism.

func NewSocketTransport

func NewSocketTransport(conn net.Conn, keepAlive int) Transport

NewSocketTransport creates a socket class stream transport.

func NewWebSocketTransport

func NewWebSocketTransport(conn WebSocketConn, keepAlive int) Transport

NewWebSocketTransport creates a socket class stream transport.

type TransportType

type TransportType int

TransportType represents a stream transport type (socket).

const (
	// Socket represents a socket transport type.
	Socket TransportType = iota + 1

	// WebSocket represents a websocket transport type.
	WebSocket
)

func (TransportType) String

func (tt TransportType) String() string

String returns TransportType string representation.

type WebSocketConn

type WebSocketConn interface {
	NextReader() (messageType int, r io.Reader, err error)
	NextWriter(int) (io.WriteCloser, error)
	Close() error
	UnderlyingConn() net.Conn
	SetReadDeadline(t time.Time) error
}

WebSocketConn represents a websocket connection interface.