peer

README

#Summary

Peer is a connection management library. The main function is to search for peers and propagate around them. It also keeps a certain number of peers and avoids network bias 피어를 검색하고 주변에 전파하는 역할이 주 기능입니다. 또한 일정 수 의 피어를 유지하도록 하며, 망 쏠림 현상을 기피합니다.

Functions

NewManager(ChainCoord *common.Coordinate, mh *message.Handler, cfg Config) (Manager, error)

type Manager interface {
	RegisterEventHandler(eh EventHandler)
	StartManage()
	EnforceConnect()
	AddNode(addr string) error
	BroadCast(m message.Message)
	NodeList() []string
	ConnectedList() []string
	TargetCast(addr string, m message.Message) error
	ExceptCast(addr string, m message.Message)
}

type Peer interface {
	net.Conn
	Send(m message.Message)
	PingTime() time.Duration
	SetPingTime(t time.Duration)
	ConnectedTime() int64
	IsClose() bool
}

type EventHandler interface {
	PeerConnected(p Peer)
	PeerClosed(p Peer)
}

NewManager(ChainCoord *common.Coordinate, mh *message.Handler, cfg Config) (Manager, error)

NewManager is the constructor of the peer manager.
This constructor receives StorePath and BanEvilScore as parameters.

Config consists of:

type Config struct {
	StorePath string
	BanEvilScore uint16
}

The StorePath field is the path to the DB file and the BanEvilleScore field is the base score for ban the peer.
StorePath 필드는 DB 파일의 경로이며 BanEvilScore 필드는 피어를 ban하는 기준 점수입니다.

Manager

RegisterEventHandler(eh EventHandler)

This function is used to register handlers that require events at the time of connecting and disconnecting peers.
이 함수는 peer가 연결되고 끊어지는 시점의 이벤트를 필요로하는 handler를 등록할때 사용합니다.
The parameters of the RegisterEventHandler must implement EventHandler.
RegisterEventHandler의 파라미터는 EventHandler를 구현해야 합니다.

StartManage()

This function initiates the functions that peer managers need to communicate with outside and manage their peers.
이 함수는 피어 매니저가 외부와 통신을 하고, 피어들을 관리하는데 필요한 기능들을 시작합니다.

AddNode(addr string) error

This function is used to add nodes directly.
직접적으로 Node를 추가할 때 사용하는 함수 입니다.

BroadCast(m message.Message)

This function used to transfer messages to all connected nodes.
연결되어 있는 모든 노드에 message를 전송할 때 사용하는 함수입니다.

NodeList() []string

This function returns a peer list with a connected record even once.
한번이라도 연결된 기록이 있는 peer 목록을 리턴하는 함수 입니다.
It can be removed from the list by evil score.
evil score에 의해 목록에서 제거될 수 있습니다.

ConnectedList() []string

This function returns the list of currently connected peers.
현재 연결되어 있는 peer의 목록을 리턴하는 함수 입니다.
This returns the list of peers connected to the calling time of the function, so must check the connection before using it.
함수의 호출시점에 연결되어 있는 peer의 목록을 리턴 하므로, 사용시에 disconnection을 확인 후에 사용해야 합니다.

TargetCast(addr string, m message.Message) error

Send a message by specifying the target peer as a parameter.
목표 피어를 파라미터로 지정하여 message를 전송합니다.
Returns an ErrNotFoundPer error if not found the target peer.
목표한 피어가 없을 경우 ErrNotFoundPeer 에러를 리턴합니다.

ExceptCast(addr string, m message.Message)

Specify a specific peer to send a message to all connected peers except for that peer.
특정 피어를 지정하여 해당 피어만 제외하고 연결된 모든 피어에 message를 전송합니다.

Peer

net.Conn

This is included to use the peer structure as a "net.Conn".
Peer 구조체를 net.Conn 처럼 사용하기 위해 포함합니다.

Send(m message.Message)

Send message to peer.

PingTime() time.Duration

Returns the ping time of this peer.

SetPingTime(t time.Duration)

Sets the ping time of this peer.

ConnectedTime() int64

Returns the created time of this peer

IsClose() bool

Returns the peer close status

EventHandler

Interface used to perform additional tasks externally when a peer is connected and disconnected.
외부에서 피어가 연결된 시점과 연결이 끊긴 시점에 추가적인 동작을 수행 할 수 있도록 도와주는 인터페이스 입니다.

PeerConnected(p Peer)

Called after the connection is established and the data is ready to read and send
연결이 수립되고 데이터를 읽을 준비를 완료한 후에 호출됩니다.

PeerDisconnected(p Peer)

This function is called just before net.Conn closes.
net.Conn이 close 되기 바로 직전에 호출됩니다.
It can't send or receive any additional data, but it can see the instantly available data to net.Conn.
추가적으로 데이터를 주고받을순 없지만 net.Conn에서 즉각적으로 사용할 수 있는 데이터를 열람 할 수 있습니다.

Documentation

Index

• Variables
• func NewManager(ChainCoord *common.Coordinate, r router.Router, Config *Config) (*manager, error)
• type BanPeerInfo
  • func (p BanPeerInfo) String() string
• type ByTime
  • func NewByTime() *ByTime
  • func (a *ByTime) Add(netAddr string, Seconds int64)
  • func (a *ByTime) Delete(netAddr string)
  • func (a *ByTime) IsBan(netAddr string) bool
  • func (a *ByTime) Len() int
  • func (a *ByTime) Less(i, j int) bool
  • func (a *ByTime) Search(netAddr string) int
  • func (a *ByTime) Swap(i, j int)
• type Config
• type Manager
• type Peer

Variables

var (
	ErrIsBanAddress       = errors.New("is ban address")
	ErrIsAlreadyConnected = errors.New("is already connected")
)

router error list

var (
	ErrNotFoundPeer = errors.New("not found peer")
)

peer errors

Functions

func NewManager

func NewManager(ChainCoord *common.Coordinate, r router.Router, Config *Config) (*manager, error)

NewManager is the peerManager creator. Apply messages necessary for peer management.

Types

type BanPeerInfo

type BanPeerInfo struct {
	NetAddr  string
	Timeout  int64
	OverTime int64
}

func (BanPeerInfo) String

func (p BanPeerInfo) String() string

type ByTime

type ByTime struct {
	Arr []*BanPeerInfo
	Map map[string]*BanPeerInfo
}

ByTime implements sort.Interface for []BanPeerInfo on the Timeout field.

func NewByTime

func NewByTime() *ByTime

func (*ByTime) Add

func (a *ByTime) Add(netAddr string, Seconds int64)

func (*ByTime) Delete

func (a *ByTime) Delete(netAddr string)

func (*ByTime) IsBan

func (a *ByTime) IsBan(netAddr string) bool

func (*ByTime) Len

func (a *ByTime) Len() int

func (*ByTime) Less

func (a *ByTime) Less(i, j int) bool

func (*ByTime) Search

func (a *ByTime) Search(netAddr string) int

func (*ByTime) Swap

func (a *ByTime) Swap(i, j int)

type Config

type Config struct {
	StorePath string
}

Config is structure storing settings information

type Manager

type Manager interface {
	RegisterEventHandler(eh mesh.EventHandler)
	StartManage()
	EnforceConnect()
	AddNode(addr string) error
	BroadCast(m message.Message)
	BroadCastLimit(m message.Message, Limint int)
	NodeList() []string
	ConnectedList() []string
	TargetCast(addr string, m message.Message) error
	ExceptCast(addr string, m message.Message)
	ExceptCastLimit(addr string, m message.Message, Limit int)
}

Manager manages peer-connected networks.

type Peer

type Peer interface {
	router.Conn
	Send(m message.Message) error
	PingTime() time.Duration
	SetPingTime(t time.Duration)
	ConnectedTime() int64
	IsClose() bool
	Remove()
	NetAddr() string
}

Peer is manages connections between nodes that cause logical connections.