node

Documentation

Index

• Constants
• Variables
• type Channel
• type Node
  • func New(clipboard clipboard.Manager, peers *Storage, localClipboard Channel, ...) *Node
  • func (n *Node) Broadcast(msg *data.Message, ignore UniqueID)
  • func (n *Node) ConnectTo(addr string) error
  • func (n *Node) Metadata() *types.Device
  • func (n *Node) MonitorBuffer()
  • func (n *Node) Start() error
• type Peer
  • func AcquirePeer(conn net.Conn, addr netip.AddrPort, id *types.Device, updates Channel, ...) *Peer
  • func (p *Peer) Addr() netip.AddrPort
  • func (p *Peer) Close() error
  • func (p *Peer) Conn() net.Conn
  • func (p *Peer) Device() *types.Device
  • func (p *Peer) Receive(last *data.LastMessage)
  • func (p *Peer) Release()
  • func (p *Peer) String() string
  • func (p *Peer) Updates() Channel
• type Storage
• type UniqueID

Constants

const DataLength = 4

Variables

var (
	ErrAlreadyConnected = errors.New("already connected")
)

Types

type Channel

type Channel chan *data.Message

Channel is an interface for managing clipboard data.

type Node

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

func New

func New(
	clipboard clipboard.Manager,
	peers *Storage,
	localClipboard Channel,
	publicPort int,
	bitSize int,
	keepAliveDelay time.Duration,
	clipboardScanDelay time.Duration,
	writeTimeout time.Duration,
	lastMessage *data.LastMessage,
) *Node

New creates a new instance of Node with the specified settings.

func (*Node) Broadcast

func (n *Node) Broadcast(msg *data.Message, ignore UniqueID)

Broadcast sends a message to all connected nodes except those specified in the 'ignore' list. It first checks if the message is a duplicate of the last sent message by comparing their IDs and hashes. If the message is a duplicate, it is not sent. For each connection in the storage, it writes the message to the connection's writer. The method logs the sent messages and their hashes for debugging purposes. The 'msg' parameter is the message to be broadcast. The 'ignore' parameter is a variadic list of AddrPort to exclude from the broadcast.

func (*Node) ConnectTo

func (n *Node) ConnectTo(addr string) error

ConnectTo establishes a TCP connection to a remote clipboard at the specified address. It adds the connection to the node's storage and starts handling the connection using 'handleConnection'. The 'addr' parameter should be in the format "host:port" to specify the remote clipboard's address. If the connection is successfully established, it returns nil; otherwise, it returns an error.

func (*Node) Metadata

func (n *Node) Metadata() *types.Device

func (*Node) MonitorBuffer

func (n *Node) MonitorBuffer()

MonitorBuffer starts monitoring the clipboard and subsequently sending data to other nodes

func (*Node) Start

func (n *Node) Start() error

Start starts the node by listening for incoming connections on the specified public port. It also starts a clipboard monitor to periodically scan and update the local clipboard. When a new connection is accepted, it invokes the 'handleConnection' method to handle the connection. The 'scanDelay' parameter determines the interval at which the clipboard is scanned and updated. The method returns an error if it fails to start listening.

type Peer

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

func AcquirePeer

func AcquirePeer(
	conn net.Conn,
	addr netip.AddrPort,
	id *types.Device,
	updates Channel,
	cipher *encrypter.Cipher,
) *Peer

func (*Peer) Addr

func (p *Peer) Addr() netip.AddrPort

func (*Peer) Close

func (p *Peer) Close() error

func (*Peer) Conn

func (p *Peer) Conn() net.Conn

func (*Peer) Device

func (p *Peer) Device() *types.Device

func (*Peer) Receive

func (p *Peer) Receive(last *data.LastMessage)

func (*Peer) Release

func (p *Peer) Release()

func (*Peer) String

func (p *Peer) String() string

func (*Peer) Updates

func (p *Peer) Updates() Channel

type Storage

type Storage = storage.SyncMap[UniqueID, *Peer]

type UniqueID

type UniqueID = string