p2p

package module
v1.3.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2022 License: GPL-3.0 Imports: 20 Imported by: 4

README

Golang simple TCP client and server

Golang-p2p is a small client and server to make p2p communication over TCP with RSA encryption.

Main aim the package is to create an easy way of microservices communication.

Features

Feature Description
Gob, Json and Bytes support You can send you structure or data in binary presentation or binary serialized
RSA handshake Every communication between a client and a server starts with RSA public keys handshake.
All sending data are encrypted before sending.

Import

import "github.com/leprosus/golang-p2p"

Server example

package main

import (
	"context"
	"fmt"
	"log"

	p2p "github.com/leprosus/golang-p2p"
)

type Hello struct {
	Text string
}

type Buy struct {
	Text string
}

func main() {
	tcp := p2p.NewTCP("localhost", "8080")

	server, err := p2p.NewServer(tcp)
	if err != nil {
		log.Panicln(err)
	}

	server.SetHandle("dialog", func(ctx context.Context, req p2p.Data) (res p2p.Data, err error) {
		hello := Hello{}
		err = req.GetGob(&hello)
		if err != nil {
			return
		}

		fmt.Printf("> Hello: %s\n", hello.Text)

		res = p2p.Data{}
		err = res.SetGob(Buy{
			Text: hello.Text,
		})

		return
	})

	err = server.Serve()
	if err != nil {
		log.Panicln(err)
	}
}

Client example

package main

import (
	"fmt"
	"log"

	p2p "github.com/leprosus/golang-p2p"
)

type Hello struct {
	Text string
}

type Buy struct {
	Text string
}

func main() {
	tcp := p2p.NewTCP("localhost", "8080")

	client, err := p2p.NewClient(tcp)
	if err != nil {
		log.Panicln(err)
	}

	var req, res p2p.Data

	for i := 0; i < 10; i++ {
		req = p2p.Data{}
		err = req.SetGob(Hello{
			Text: fmt.Sprintf("User #%d", i+1),
		})
		if err != nil {
			log.Panicln(err)
		}

		res = p2p.Data{}
		res, err = client.Send("dialog", req)
		if err != nil {
			log.Panicln(err)
		}

		var buy Buy
		err = res.GetGob(&buy)
		if err != nil {
			log.Panicln(err)
		}

		fmt.Printf("> Buy: %s\n", buy.Text)
	}
}

Running

If you run the server and the client separately then you see:

  • in the server stdout:
> Hello: User #1
dialog: addr (127.0.0.1:50099), handshake (2 ms), read (7 ms), handle (278 µs), write (301 µs), total (10 ms)
> Hello: User #2
dialog: addr (127.0.0.1:50100), read (743 µs), handle (238 µs), write (219 µs), total (1 ms)
> Hello: User #3
dialog: addr (127.0.0.1:50101), read (834 µs), handle (233 µs), write (228 µs), total (1 ms)
> Hello: User #4
dialog: addr (127.0.0.1:50102), read (547 µs), handle (227 µs), write (260 µs), total (1 ms)
> Hello: User #5
dialog: addr (127.0.0.1:50103), read (625 µs), handle (230 µs), write (271 µs), total (1 ms)
> Hello: User #6
dialog: addr (127.0.0.1:50104), read (602 µs), handle (241 µs), write (234 µs), total (1 ms)
> Hello: User #7
dialog: addr (127.0.0.1:50105), read (589 µs), handle (258 µs), write (227 µs), total (1 ms)
> Hello: User #8
dialog: addr (127.0.0.1:50106), read (635 µs), handle (232 µs), write (221 µs), total (1 ms)
> Hello: User #9
dialog: addr (127.0.0.1:50107), read (1 ms), handle (376 µs), write (365 µs), total (1 ms)
> Hello: User #10
dialog: addr (127.0.0.1:50108), read (635 µs), handle (370 µs), write (434 µs), total (1 ms)
  • in the client stdout:
dialog: addr (127.0.0.1:8080), handshake (8 ms), write (480 µs), read (1 ms), total (10 ms)
> Buy: User #1
dialog: addr (127.0.0.1:8080), write (342 µs), read (1 ms), total (1 ms)
> Buy: User #2
dialog: addr (127.0.0.1:8080), write (451 µs), read (1 ms), total (1 ms)
> Buy: User #3
dialog: addr (127.0.0.1:8080), write (226 µs), read (1 ms), total (1 ms)
> Buy: User #4
dialog: addr (127.0.0.1:8080), write (246 µs), read (1 ms), total (1 ms)
> Buy: User #5
dialog: addr (127.0.0.1:8080), write (262 µs), read (1 ms), total (1 ms)
> Buy: User #6
dialog: addr (127.0.0.1:8080), write (262 µs), read (1 ms), total (1 ms)
> Buy: User #7
dialog: addr (127.0.0.1:8080), write (247 µs), read (1 ms), total (1 ms)
> Buy: User #8
dialog: addr (127.0.0.1:8080), write (599 µs), read (2 ms), total (2 ms)
> Buy: User #9
dialog: addr (127.0.0.1:8080), write (259 µs), read (2 ms), total (2 ms)
> Buy: User #10
  • logging

All lines that start from dialog is the topic for the communication.

All log lines write to StdOut.

If you want to reassign this logger you need to implement your own with the following interface:

type Logger interface {
    Info(msg string)
    Warn(msg string)
    Error(msg string)
}

and set it up in your server or client implementation this way:

settings.SetLogger(yourLogger)

List all methods

TCP Initialization
  • p2p.NewTCP(host, port) (tcp, err) - creates TCP connection
Server settings initialization
  • p2p.NewServerSettings() (stg) - creates a new server's settings
  • stg.SetConnTimeout(dur) - sets connection timout
  • stg.SetHandleTimeout(dur) - sets handle timout
  • stg.SetBodyLimit(limit) - sets max body size for reading
Server
  • p2p.NewServer(tcp) (srv, err) - creates a new server
  • srv.SetSettings(stg) - sets settings
  • srv.SetLogger(l) - reassigns server's logger
  • srv.SetHandle(topic, handler) - sets a handler that processes all request with defined topic
  • srv.SetContext(ctx) - sets context
  • srv.Serve() (err) - starts to serve
Client settings initialization
  • p2p.NewClientSettings() (stg) - creates a new server's settings
  • stg.SetConnTimeout(dur) - sets connection timout
  • stg.SetBodyLimit(limit) - sets max body size for writing
  • stg.SetRetry(retries, delay) - sets retry parameters
Client
  • NewClient(tcp, stg) (clt, err) - creates a new client
  • clt.SetSettings(stg) - sets settings
  • clt.SetLogger(l) - reassigns client's logger
  • clt.Send(topic, req) (res, err) - sends a request to a server by the topic
Request
  • req.SetBytes(bs) - sets bytes to the request
  • req.GetBytes() (bs) - gets bytes from the request
  • req.SetGob(obj) (err) - encodes to Gob and sets structure to the request
  • req.GetGob(obj) (err) - decode from Gob and gets structure from the request
  • req.SetJson(obj) (err) - encodes to Json and sets structure to the request
  • req.GetJson(obj) (err) - decode from Json and gets structure from the request
  • req.String() (str) - returns string from the request
Response
  • res.SetBytes(bs) - sets bytes to the response
  • res.GetBytes() (bs) - gets bytes from the response
  • res.SetGob(obj) (err) - encodes to Gob and sets structure to the response
  • res.GetGob(obj) (err) - decode from Gob and gets structure from the response
  • res.SetJson(obj) (err) - encodes to Json and sets structure to the response
  • res.GetJson(obj) (err) - decode from Json and gets structure from the response
  • res.String() (str) - returns string from the response

Documentation

Index

Constants

View Source 
const (
	DefaultConnTimeout   = 250 * time.Millisecond
	DefaultHandleTimeout = 250 * time.Millisecond
)
View Source 
const (
	DefaultRetries      = 3
	DefaultDelayTimeout = 50 * time.Millisecond
)
View Source 
const DefaultBodyLimit = 1024

Variables

View Source 
var (
	UnsupportedPackage    = errors.New("unsupported package type")
	UnsupportedTopic      = errors.New("unsupported topic")
	ConnectionError       = errors.New("connection error")
	PresetConnectionError = errors.New("preset connection error")
)

Functions

func NewStdLogger added in v1.2.0 

func NewStdLogger() (l *stdLogger)

Types

type CipherKey added in v1.3.2 

type CipherKey []byte

func NewCipherKey added in v1.3.2 

func NewCipherKey() (key CipherKey, err error)

func (CipherKey) Decode added in v1.3.2 

func (key CipherKey) Decode(bs []byte) (rs []byte, err error)

func (CipherKey) Encode added in v1.3.2 

func (key CipherKey) Encode(bs []byte) (rs []byte, err error)

type Client added in v1.2.0 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient added in v1.2.0 

func NewClient(tcp *TCP) (c *Client, err error)

func (*Client) Send added in v1.2.0 

func (c *Client) Send(topic string, req Data) (res Data, err error)

func (*Client) SetLogger added in v1.3.10 

func (c *Client) SetLogger(logger Logger)

func (*Client) SetSettings added in v1.3.9 

func (c *Client) SetSettings(stg *ClientSettings)

type ClientSettings added in v1.2.0 

type ClientSettings struct {
	Limiter
	Retry
}

func NewClientSettings added in v1.2.0 

func NewClientSettings() (stg *ClientSettings)

func (*ClientSettings) SetBodyLimit added in v1.2.2 

func (stg *ClientSettings) SetBodyLimit(limit uint)

func (*ClientSettings) SetConnTimeout added in v1.2.0 

func (stg *ClientSettings) SetConnTimeout(dur time.Duration)

func (*ClientSettings) SetRetry added in v1.2.0 

func (stg *ClientSettings) SetRetry(retries uint, delay time.Duration)

type Conn added in v1.2.0 

type Conn struct {
	net.Conn
	// contains filtered or unexported fields
}

func NewConn added in v1.3.3 

func NewConn(conn net.Conn, limiter Limiter) (c Conn, err error)

func (*Conn) ReadPackage added in v1.3.3 

func (c *Conn) ReadPackage(p *Package) (err error)

func (*Conn) WritePackage added in v1.3.3 

func (c *Conn) WritePackage(p Package) (err error)

type CryptCipherKey added in v1.3.2 

type CryptCipherKey []byte

type CryptMessage added in v1.3.1 

type CryptMessage []byte

func (CryptMessage) Decode added in v1.3.1 

func (cm CryptMessage) Decode(ck CipherKey) (msg Message, err error)

type Data added in v1.3.3 

type Data struct {
	Bytes []byte
}

func (*Data) GetBytes added in v1.3.3 

func (d *Data) GetBytes() (bs []byte)

func (*Data) GetGob added in v1.3.3 

func (d *Data) GetGob(val interface{}) (err error)

func (*Data) GetJson added in v1.3.3 

func (d *Data) GetJson(val interface{}) (err error)

func (*Data) SetBytes added in v1.3.3 

func (d *Data) SetBytes(bs []byte)

func (*Data) SetGob added in v1.3.3 

func (d *Data) SetGob(val interface{}) (err error)

func (*Data) SetJson added in v1.3.3 

func (d *Data) SetJson(val interface{}) (err error)

func (*Data) String added in v1.3.3 

func (d *Data) String() (str string)

type Handler added in v1.2.0 

type Handler func(ctx context.Context, req Data) (res Data, err error)

type HandlerType added in v1.2.5 

type HandlerType uint

type Limiter added in v1.2.0 

type Limiter struct {
	Timeout
	// contains filtered or unexported fields
}

type Logger added in v1.2.0 

type Logger interface {
	Info(msg string)
	Warn(msg string)
	Error(msg string)
}

type Message added in v1.2.0 

type Message struct {
	Topic   string
	Content []byte
	Error   error
}

func (Message) Encode added in v1.3.1 

func (msg Message) Encode(ck CipherKey) (cm CryptMessage, err error)

type Metrics added in v1.2.0 

type Metrics struct {
	// contains filtered or unexported fields
}

type Package added in v1.3.3 

type Package struct {
	Type PackageType
	Data
}

type PackageType added in v1.3.3 

type PackageType uint8
const (
	Handshake PackageType = iota
	Exchange
	Error
)

type PrivateKey added in v1.3.1 

type PrivateKey struct {
	// contains filtered or unexported fields
}

func (PrivateKey) Decode added in v1.3.1 

func (pk PrivateKey) Decode(cck CryptCipherKey) (ck CipherKey, err error)

type PublicKey added in v1.3.1 

type PublicKey struct {
	Key rsa.PublicKey
}

func (PublicKey) Encode added in v1.3.1 

func (pk PublicKey) Encode(ck CipherKey) (cck CryptCipherKey, err error)

type RSA added in v1.3.1 

type RSA struct {
	// contains filtered or unexported fields
}

func NewRSA added in v1.3.1 

func NewRSA() (r *RSA, err error)

func (*RSA) PrivateKey added in v1.3.1 

func (r *RSA) PrivateKey() (pk PrivateKey)

func (*RSA) PublicKey added in v1.3.1 

func (r *RSA) PublicKey() (pk PublicKey)

type Retry added in v1.2.0 

type Retry struct {
	// contains filtered or unexported fields
}

type Server added in v1.2.0 

type Server struct {
	// contains filtered or unexported fields
}

func NewServer added in v1.2.0 

func NewServer(tcp *TCP) (s *Server, err error)

func (*Server) Serve added in v1.2.0 

func (s *Server) Serve() (err error)

func (*Server) SetContext added in v1.2.4 

func (s *Server) SetContext(ctx context.Context)

func (*Server) SetHandle added in v1.3.0 

func (s *Server) SetHandle(topic string, handler Handler)

func (*Server) SetLogger added in v1.3.10 

func (s *Server) SetLogger(logger Logger)

func (*Server) SetSettings added in v1.3.9 

func (s *Server) SetSettings(stg *ServerSettings)

type ServerSettings added in v1.2.0 

type ServerSettings struct {
	Limiter
}

func NewServerSettings added in v1.2.0 

func NewServerSettings() (stg *ServerSettings)

func (*ServerSettings) SetBodyLimit added in v1.2.2 

func (stg *ServerSettings) SetBodyLimit(limit uint)

func (*ServerSettings) SetConnTimeout added in v1.2.0 

func (stg *ServerSettings) SetConnTimeout(dur time.Duration)

func (*ServerSettings) SetHandleTimeout added in v1.2.0 

func (stg *ServerSettings) SetHandleTimeout(dur time.Duration)

type TCP 

type TCP struct {
	// contains filtered or unexported fields
}

func NewTCP 

func NewTCP(host, port string) (tcp *TCP)

type Timeout added in v1.2.0 

type Timeout struct {
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
_example
client
server

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.