server

Documentation

Index

• Variables
• type Connection
• type OnConnectedHandler
• type OnDisconnectedHandler
• type OnInvalidMessageHandler
• type Server

Variables

var ErrNetwork = errors.New("network error")

ErrNetwork is an error related to the internals of the connection, and not an error that came from outside (e.g. from OnDisconnectedHandler).

Types

type Connection

type Connection interface {
	fmt.Stringer
	Start(router *router.Router)
	Disconnect()
	IsConnected() bool
	IsOutbound() bool
	SetOnDisconnectedHandler(onDisconnectedHandler OnDisconnectedHandler)
	SetOnInvalidMessageHandler(onInvalidMessageHandler OnInvalidMessageHandler)
	Address() *net.TCPAddr
}

Connection represents a p2p server connection.

type OnConnectedHandler

type OnConnectedHandler func(connection Connection) error

OnConnectedHandler is a function that is to be called once a new Connection is successfully established.

type OnDisconnectedHandler

type OnDisconnectedHandler func()

OnDisconnectedHandler is a function that is to be called once a Connection has been disconnected.

type OnInvalidMessageHandler

type OnInvalidMessageHandler func(err error)

OnInvalidMessageHandler is a function that is to be called when an invalid message (cannot be parsed/doesn't have a route) was received from a connection.

type Server

type Server interface {
	Connect(address string) (Connection, error)
	Start() error
	Stop() error
	SetOnConnectedHandler(onConnectedHandler OnConnectedHandler)
}

Server represents a p2p server.