package p2p

import "github.com/Diarkis/diarkis/proto/go/p2p"

Index

Constants

const RelayCmd uint16 = 302

RelayCmd represents the command ID of the protocol's command ID. 

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const RelayVer uint8 = 1

RelayVer represents the ver of the protocol's command. 

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const RequestHolePunchCmd uint16 = 303

RequestHolePunchCmd represents the command ID of the protocol's command ID. 

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const RequestHolePunchVer uint8 = 1

RequestHolePunchVer represents the ver of the protocol's command. 

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const SuccessCmd uint16 = 301

SuccessCmd represents the command ID of the protocol's command ID. 

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const SuccessVer uint8 = 1

SuccessVer represents the ver of the protocol's command. 

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

Types

type Relay

type Relay struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd      uint16
	Message  []byte
	Reliable bool
}

Relay represents the command protocol data structure.

func NewRelay

func NewRelay() *Relay

NewRelay creates a new instance of Relay struct.

func (*Relay) GetCmd

func (proto *Relay) GetCmd() uint16

func (*Relay) GetVer

func (proto *Relay) GetVer() uint8

func (*Relay) Pack

func (proto *Relay) Pack() []byte

Pack encodes Relay struct to a byte array to be delivered over the command.

func (*Relay) PackedSize

func (proto *Relay) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Relay) String

func (proto *Relay) String() string

func (*Relay) Unpack

func (proto *Relay) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Relay struct.

type RequestHolePunch

type RequestHolePunch struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd           uint16
	TargetAddress string
}

RequestHolePunch represents the command protocol data structure.

func NewRequestHolePunch

func NewRequestHolePunch() *RequestHolePunch

NewRequestHolePunch creates a new instance of RequestHolePunch struct.

func (*RequestHolePunch) GetCmd

func (proto *RequestHolePunch) GetCmd() uint16

func (*RequestHolePunch) GetVer

func (proto *RequestHolePunch) GetVer() uint8

func (*RequestHolePunch) Pack

func (proto *RequestHolePunch) Pack() []byte

Pack encodes RequestHolePunch struct to a byte array to be delivered over the command.

func (*RequestHolePunch) PackedSize

func (proto *RequestHolePunch) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*RequestHolePunch) String

func (proto *RequestHolePunch) String() string

func (*RequestHolePunch) Unpack

func (proto *RequestHolePunch) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to RequestHolePunch struct.

type Success

type Success struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
}

Success represents the command protocol data structure.

func NewSuccess

func NewSuccess() *Success

NewSuccess creates a new instance of Success struct.

func (*Success) GetCmd

func (proto *Success) GetCmd() uint16

func (*Success) GetVer

func (proto *Success) GetVer() uint8

func (*Success) Pack

func (proto *Success) Pack() []byte

Pack encodes Success struct to a byte array to be delivered over the command.

func (*Success) PackedSize

func (proto *Success) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Success) String

func (proto *Success) String() string

func (*Success) Unpack

func (proto *Success) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Success struct.