protocol

Documentation

Overview

Package protocol is a generated protocol buffer package.

It is generated from these files:

kademlia.proto

It has these top-level messages:

Node
PingRequest
PingResponse
ProbeRequest
ProbeResponse

Package protocol implements the network layer of the kademlia protocol.

Index

• func RegisterKademliaServer(s *grpc.Server, srv KademliaServer)
• type KademliaClient
  • func NewKademliaClient(cc *grpc.ClientConn) KademliaClient
• type KademliaServer
• type Node
  • func (*Node) Descriptor() ([]byte, []int)
  • func (m *Node) GetID() []byte
  • func (m *Node) GetIP() string
  • func (m *Node) GetPort() int32
  • func (*Node) ProtoMessage()
  • func (m *Node) Reset()
  • func (m *Node) String() string
• type PingRequest
  • func (*PingRequest) Descriptor() ([]byte, []int)
  • func (m *PingRequest) GetReceiver() *Node
  • func (m *PingRequest) GetSender() *Node
  • func (*PingRequest) ProtoMessage()
  • func (m *PingRequest) Reset()
  • func (m *PingRequest) String() string
• type PingResponse
  • func (*PingResponse) Descriptor() ([]byte, []int)
  • func (m *PingResponse) GetReceiver() *Node
  • func (m *PingResponse) GetSender() *Node
  • func (*PingResponse) ProtoMessage()
  • func (m *PingResponse) Reset()
  • func (m *PingResponse) String() string
• type ProbeRequest
  • func (*ProbeRequest) Descriptor() ([]byte, []int)
  • func (m *ProbeRequest) GetKey() []byte
  • func (m *ProbeRequest) GetReceiver() *Node
  • func (m *ProbeRequest) GetSender() *Node
  • func (*ProbeRequest) ProtoMessage()
  • func (m *ProbeRequest) Reset()
  • func (m *ProbeRequest) String() string
• type ProbeResponse
  • func (*ProbeResponse) Descriptor() ([]byte, []int)
  • func (m *ProbeResponse) GetKey() []byte
  • func (m *ProbeResponse) GetNearest() []*Node
  • func (m *ProbeResponse) GetReceiver() *Node
  • func (m *ProbeResponse) GetSender() *Node
  • func (*ProbeResponse) ProtoMessage()
  • func (m *ProbeResponse) Reset()
  • func (m *ProbeResponse) String() string

Functions

func RegisterKademliaServer

func RegisterKademliaServer(s *grpc.Server, srv KademliaServer)

Types

type KademliaClient

type KademliaClient interface {
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
	Probe(ctx context.Context, in *ProbeRequest, opts ...grpc.CallOption) (*ProbeResponse, error)
}

func NewKademliaClient

func NewKademliaClient(cc *grpc.ClientConn) KademliaClient

type KademliaServer

type KademliaServer interface {
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	Probe(context.Context, *ProbeRequest) (*ProbeResponse, error)
}

type Node

type Node struct {
	// ID is a 20 byte unique identifier
	ID []byte `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`
	// IP is the public address IP of the node
	IP string `protobuf:"bytes,2,opt,name=IP" json:"IP,omitempty"`
	// Port is the public port of the node
	Port int32 `protobuf:"varint,3,opt,name=Port" json:"Port,omitempty"`
}

func (*Node) Descriptor

func (*Node) Descriptor() ([]byte, []int)

func (*Node) GetID

func (m *Node) GetID() []byte

func (*Node) GetIP

func (m *Node) GetIP() string

func (*Node) GetPort

func (m *Node) GetPort() int32

func (*Node) ProtoMessage

func (*Node) ProtoMessage()

func (*Node) Reset

func (m *Node) Reset()

func (*Node) String

func (m *Node) String() string

type PingRequest

type PingRequest struct {
	Sender   *Node `protobuf:"bytes,1,opt,name=Sender" json:"Sender,omitempty"`
	Receiver *Node `protobuf:"bytes,2,opt,name=Receiver" json:"Receiver,omitempty"`
}

func (*PingRequest) Descriptor

func (*PingRequest) Descriptor() ([]byte, []int)

func (*PingRequest) GetReceiver

func (m *PingRequest) GetReceiver() *Node

func (*PingRequest) GetSender

func (m *PingRequest) GetSender() *Node

func (*PingRequest) ProtoMessage

func (*PingRequest) ProtoMessage()

func (*PingRequest) Reset

func (m *PingRequest) Reset()

func (*PingRequest) String

func (m *PingRequest) String() string

type PingResponse

type PingResponse struct {
	Sender   *Node `protobuf:"bytes,1,opt,name=Sender" json:"Sender,omitempty"`
	Receiver *Node `protobuf:"bytes,2,opt,name=Receiver" json:"Receiver,omitempty"`
}

func (*PingResponse) Descriptor

func (*PingResponse) Descriptor() ([]byte, []int)

func (*PingResponse) GetReceiver

func (m *PingResponse) GetReceiver() *Node

func (*PingResponse) GetSender

func (m *PingResponse) GetSender() *Node

func (*PingResponse) ProtoMessage

func (*PingResponse) ProtoMessage()

func (*PingResponse) Reset

func (m *PingResponse) Reset()

func (*PingResponse) String

func (m *PingResponse) String() string

type ProbeRequest

type ProbeRequest struct {
	Sender   *Node  `protobuf:"bytes,1,opt,name=Sender" json:"Sender,omitempty"`
	Receiver *Node  `protobuf:"bytes,2,opt,name=Receiver" json:"Receiver,omitempty"`
	Key      []byte `protobuf:"bytes,3,opt,name=Key,proto3" json:"Key,omitempty"`
}

func (*ProbeRequest) Descriptor

func (*ProbeRequest) Descriptor() ([]byte, []int)

func (*ProbeRequest) GetKey

func (m *ProbeRequest) GetKey() []byte

func (*ProbeRequest) GetReceiver

func (m *ProbeRequest) GetReceiver() *Node

func (*ProbeRequest) GetSender

func (m *ProbeRequest) GetSender() *Node

func (*ProbeRequest) ProtoMessage

func (*ProbeRequest) ProtoMessage()

func (*ProbeRequest) Reset

func (m *ProbeRequest) Reset()

func (*ProbeRequest) String

func (m *ProbeRequest) String() string

type ProbeResponse

type ProbeResponse struct {
	Sender   *Node   `protobuf:"bytes,1,opt,name=Sender" json:"Sender,omitempty"`
	Receiver *Node   `protobuf:"bytes,2,opt,name=Receiver" json:"Receiver,omitempty"`
	Key      []byte  `protobuf:"bytes,3,opt,name=Key,proto3" json:"Key,omitempty"`
	Nearest  []*Node `protobuf:"bytes,4,rep,name=nearest" json:"nearest,omitempty"`
}

func (*ProbeResponse) Descriptor

func (*ProbeResponse) Descriptor() ([]byte, []int)

func (*ProbeResponse) GetKey

func (m *ProbeResponse) GetKey() []byte

func (*ProbeResponse) GetNearest

func (m *ProbeResponse) GetNearest() []*Node

func (*ProbeResponse) GetReceiver

func (m *ProbeResponse) GetReceiver() *Node

func (*ProbeResponse) GetSender

func (m *ProbeResponse) GetSender() *Node

func (*ProbeResponse) ProtoMessage

func (*ProbeResponse) ProtoMessage()

func (*ProbeResponse) Reset

func (m *ProbeResponse) Reset()

func (*ProbeResponse) String

func (m *ProbeResponse) String() string