handshake

package

v0.35.0 Latest Latest Go to latest Published: Apr 24, 2023 License: Apache-2.0 Imports: 4 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/blinklabs-io/gouroboros

Links

Open Source Insights

Documentation ¶

Overview ¶

Package handshake implements the Ouroboros handshake protocol

Index ¶

Constants
Variables
func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)
type Client
- func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client
- func (c *Client) Start()
type Config
- func NewConfig(options ...HandshakeOptionFunc) Config
type FinishedFunc
type Handshake
- func New(protoOptions protocol.ProtocolOptions, cfg *Config) *Handshake
type HandshakeOptionFunc
- func WithClientFullDuplex(fullDuplex bool) HandshakeOptionFunc
- func WithFinishedFunc(finishedFunc FinishedFunc) HandshakeOptionFunc
- func WithNetworkMagic(networkMagic uint32) HandshakeOptionFunc
- func WithProtocolVersions(versions []uint16) HandshakeOptionFunc
- func WithTimeout(timeout time.Duration) HandshakeOptionFunc
type MsgAcceptVersion
- func NewMsgAcceptVersion(version uint16, versionData interface{}) *MsgAcceptVersion
type MsgProposeVersions
- func NewMsgProposeVersions(versionMap map[uint16]interface{}) *MsgProposeVersions
type MsgRefuse
- func NewMsgRefuse(reason []interface{}) *MsgRefuse
type Server
- func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server

Constants ¶

View Source

const (
	DiffusionModeInitiatorOnly         = false
	DiffusionModeInitiatorAndResponder = true
)

Diffusion modes

View Source

const (
	MessageTypeProposeVersions = 0
	MessageTypeAcceptVersion   = 1
	MessageTypeRefuse          = 2
)

Message types

View Source

const (
	RefuseReasonVersionMismatch = 0
	RefuseReasonDecodeError     = 1
	RefuseReasonRefused         = 2
)

Refusal reasons

Variables ¶

View Source

var StateMap = protocol.StateMap{
	// contains filtered or unexported fields
}

Handshake protocol state machine

Functions ¶

func NewMsgFromCbor ¶

func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)

NewMsgFromCbor parses a Handshake message from CBOR

Types ¶

type Client ¶

type Client struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

Client implements the Handshake client

func NewClient ¶

func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client

NewClient returns a new Handshake client object

func (*Client) Start ¶

func (c *Client) Start()

Start begins the handshake process

type Config ¶

type Config struct {
	ProtocolVersions []uint16
	NetworkMagic     uint32
	ClientFullDuplex bool
	FinishedFunc     FinishedFunc
	Timeout          time.Duration
}

Config is used to configure the Handshake protocol instance

func NewConfig ¶

func NewConfig(options ...HandshakeOptionFunc) Config

NewConfig returns a new Handshake config object with the provided options

type FinishedFunc ¶

type FinishedFunc func(uint16, bool) error

Callback function types

type Handshake ¶

type Handshake struct {
	Client *Client
	Server *Server
}

Handshake is a wrapper object that holds the client and server instances

func New ¶

func New(protoOptions protocol.ProtocolOptions, cfg *Config) *Handshake

New returns a new Handshake object

type HandshakeOptionFunc ¶

type HandshakeOptionFunc func(*Config)

HandshakeOptionFunc represents a function used to modify the Handshake protocol config

func WithClientFullDuplex ¶

func WithClientFullDuplex(fullDuplex bool) HandshakeOptionFunc

WithClientFullDuplex specifies whether to request full duplex mode when acting as a client

func WithFinishedFunc ¶

func WithFinishedFunc(finishedFunc FinishedFunc) HandshakeOptionFunc

WithFinishedFunc specifies the Finished callback function

func WithNetworkMagic ¶

func WithNetworkMagic(networkMagic uint32) HandshakeOptionFunc

WithNetworkMagic specifies the network magic value

func WithProtocolVersions ¶

func WithProtocolVersions(versions []uint16) HandshakeOptionFunc

WithProtocolVersions specifies the supported protocol versions

func WithTimeout ¶

func WithTimeout(timeout time.Duration) HandshakeOptionFunc

WithTimeout specifies the timeout for the handshake operation

type MsgAcceptVersion ¶

type MsgAcceptVersion struct {
	protocol.MessageBase
	Version     uint16
	VersionData interface{}
}

func NewMsgAcceptVersion ¶

func NewMsgAcceptVersion(version uint16, versionData interface{}) *MsgAcceptVersion

type MsgProposeVersions ¶

type MsgProposeVersions struct {
	protocol.MessageBase
	VersionMap map[uint16]interface{}
}

func NewMsgProposeVersions ¶

func NewMsgProposeVersions(versionMap map[uint16]interface{}) *MsgProposeVersions

type MsgRefuse ¶

type MsgRefuse struct {
	protocol.MessageBase
	Reason []interface{}
}

func NewMsgRefuse ¶

func NewMsgRefuse(reason []interface{}) *MsgRefuse

type Server ¶

type Server struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

Server implements the Handshake server

func NewServer ¶

func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server

NewServer returns a new Handshake server object

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL