websocket

README

Grav Transport: Websocket

This is a streaming transport plugin for Grav that uses standard websockets.

Handler functions are made available for http.Server. Connections are managed by the Transport object.

Documentation

Index

• Constants
• type Conn
  • func (c *Conn) Close() error
  • func (c *Conn) IncomingHandshake(handshakeCallback grav.HandshakeCallback) error
  • func (c *Conn) OutgoingHandshake(handshake *grav.TransportHandshake) (*grav.TransportHandshakeAck, error)
  • func (c *Conn) ReadMsg() (grav.Message, *grav.Withdraw, error)
  • func (c *Conn) SendMsg(msg grav.Message) error
  • func (c *Conn) SendWithdraw(withdraw *grav.Withdraw) error
  • func (c *Conn) WriteMessage(messageType int, data []byte) error
• type Transport
  • func New() *Transport
  • func (t *Transport) Connect(endpoint string) (grav.Connection, error)
  • func (t *Transport) HTTPHandlerFunc() http.HandlerFunc
  • func (t *Transport) Setup(opts *grav.MeshOptions, connFunc grav.ConnectFunc) error

Constants

const (
	MsgTypeWebsocketMessage = "websocket.message"
)

Types

type Conn

type Conn struct {
	// contains filtered or unexported fields
}

Conn implements transport.Connection and represents a websocket connection

func (*Conn) Close

func (c *Conn) Close() error

Close closes the underlying connection

func (*Conn) IncomingHandshake

func (c *Conn) IncomingHandshake(handshakeCallback grav.HandshakeCallback) error

IncomingHandshake performs a connection handshake and returns the UUID of the node that we're connected to so that it can be validated against the UUID that was provided in discovery (or if none was provided)

func (*Conn) OutgoingHandshake

func (c *Conn) OutgoingHandshake(handshake *grav.TransportHandshake) (*grav.TransportHandshakeAck, error)

OutgoingHandshake performs a connection handshake and returns the UUID of the node that we're connected to so that it can be validated against the UUID that was provided in discovery (or if none was provided)

func (*Conn) ReadMsg

func (c *Conn) ReadMsg() (grav.Message, *grav.Withdraw, error)

func (*Conn) SendMsg

func (c *Conn) SendMsg(msg grav.Message) error

SendMsg sends a message to the connection

func (*Conn) SendWithdraw

func (c *Conn) SendWithdraw(withdraw *grav.Withdraw) error

SendWithdraw sends a withdraw message to the peer

func (*Conn) WriteMessage

func (c *Conn) WriteMessage(messageType int, data []byte) error

WriteMessage is a concurrent-safe wrapper around the websocket WriteMessage

type Transport

type Transport struct {
	// contains filtered or unexported fields
}

Transport is a transport that connects Grav nodes via standard websockets

func New

func New() *Transport

New creates a new websocket transport

func (*Transport) Connect

func (t *Transport) Connect(endpoint string) (grav.Connection, error)

Connect adds a websocket endpoint to emit messages to

func (*Transport) HTTPHandlerFunc

func (t *Transport) HTTPHandlerFunc() http.HandlerFunc

HTTPHandlerFunc returns an http.HandlerFunc for incoming connections

func (*Transport) Setup

func (t *Transport) Setup(opts *grav.MeshOptions, connFunc grav.ConnectFunc) error

Setup sets up the transport