driver

package

v1.2.2 Latest Latest Go to latest Published: Feb 17, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/TeoSlayer/pilotprotocol

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Conn
type Datagram
type Driver
- func Connect(socketPath string) (*Driver, error)
type Listener

Constants ¶

View Source

const DefaultSocketPath = "/tmp/pilot.sock"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Conn ¶

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

Conn implements net.Conn over a Pilot Protocol stream.

func (*Conn) Close ¶

func (c *Conn) Close() error

func (*Conn) LocalAddr ¶

func (c *Conn) LocalAddr() net.Addr

func (*Conn) Read ¶

func (c *Conn) Read(b []byte) (int, error)

func (*Conn) RemoteAddr ¶

func (c *Conn) RemoteAddr() net.Addr

func (*Conn) SetDeadline ¶

func (c *Conn) SetDeadline(t time.Time) error

func (*Conn) SetReadDeadline ¶

func (c *Conn) SetReadDeadline(t time.Time) error

func (*Conn) SetWriteDeadline ¶

func (c *Conn) SetWriteDeadline(t time.Time) error

func (*Conn) Write ¶

func (c *Conn) Write(b []byte) (int, error)

type Datagram ¶

type Datagram struct {
	SrcAddr protocol.Addr
	SrcPort uint16
	DstPort uint16
	Data    []byte
}

Datagram represents a received unreliable datagram.

type Driver ¶

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

Driver is the main entry point for the Pilot Protocol SDK.

func Connect ¶

func Connect(socketPath string) (*Driver, error)

Connect creates a new driver connected to the local daemon.

func (*Driver) ApproveHandshake ¶

func (d *Driver) ApproveHandshake(nodeID uint32) (map[string]interface{}, error)

ApproveHandshake approves a pending trust handshake request.

func (*Driver) Close ¶

func (d *Driver) Close() error

Close disconnects from the daemon.

func (*Driver) Deregister ¶

func (d *Driver) Deregister() (map[string]interface{}, error)

Deregister removes the daemon from the registry.

func (*Driver) Dial ¶

func (d *Driver) Dial(addr string) (*Conn, error)

Dial opens a stream connection to a remote address:port. addr format: "N:XXXX.YYYY.YYYY:PORT"

func (*Driver) DialAddr ¶

func (d *Driver) DialAddr(dst protocol.Addr, port uint16) (*Conn, error)

DialAddr opens a stream connection to a remote Addr + port.

func (*Driver) Disconnect ¶

func (d *Driver) Disconnect(connID uint32) error

Disconnect closes a connection by ID. Used by administrative tools.

func (*Driver) Handshake ¶

func (d *Driver) Handshake(nodeID uint32, justification string) (map[string]interface{}, error)

Handshake sends a trust handshake request to a remote node.

func (*Driver) Info ¶

func (d *Driver) Info() (map[string]interface{}, error)

Info returns the daemon's status information.

func (*Driver) Listen ¶

func (d *Driver) Listen(port uint16) (*Listener, error)

Listen binds a port and returns a Listener that accepts connections.

func (*Driver) PendingHandshakes ¶

func (d *Driver) PendingHandshakes() (map[string]interface{}, error)

PendingHandshakes returns pending trust handshake requests.

func (*Driver) RecvFrom ¶

func (d *Driver) RecvFrom() (*Datagram, error)

RecvFrom receives the next incoming datagram.

func (*Driver) RejectHandshake ¶

func (d *Driver) RejectHandshake(nodeID uint32, reason string) (map[string]interface{}, error)

RejectHandshake rejects a pending trust handshake request.

func (*Driver) ResolveHostname ¶

func (d *Driver) ResolveHostname(hostname string) (map[string]interface{}, error)

ResolveHostname resolves a hostname to node info via the daemon.

func (*Driver) RevokeTrust ¶

func (d *Driver) RevokeTrust(nodeID uint32) (map[string]interface{}, error)

RevokeTrust removes a peer from the trusted set and notifies the registry.

func (*Driver) SendTo ¶

func (d *Driver) SendTo(dst protocol.Addr, port uint16, data []byte) error

SendTo sends an unreliable datagram to the given address:port. Use with broadcast addresses (Node=0xFFFFFFFF) to send to all network members.

func (*Driver) SetHostname ¶

func (d *Driver) SetHostname(hostname string) (map[string]interface{}, error)

SetHostname sets or clears the daemon's hostname via the registry.

func (*Driver) SetTags ¶

func (d *Driver) SetTags(tags []string) (map[string]interface{}, error)

SetTags sets the capability tags for this daemon's node.

func (*Driver) SetTaskExec ¶

func (d *Driver) SetTaskExec(enabled bool) (map[string]interface{}, error)

SetTaskExec enables or disables task execution capability on the registry.

func (*Driver) SetVisibility ¶

func (d *Driver) SetVisibility(public bool) (map[string]interface{}, error)

SetVisibility sets the daemon's visibility on the registry.

func (*Driver) SetWebhook ¶

func (d *Driver) SetWebhook(url string) (map[string]interface{}, error)

SetWebhook sets or clears the daemon's webhook URL at runtime. An empty URL disables the webhook.

func (*Driver) TrustedPeers ¶

func (d *Driver) TrustedPeers() (map[string]interface{}, error)

TrustedPeers returns all trusted peers from the handshake protocol.

type Listener ¶

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

Listener implements net.Listener over a Pilot Protocol port.

func (*Listener) Accept ¶

func (l *Listener) Accept() (net.Conn, error)

func (*Listener) Addr ¶

func (l *Listener) Addr() net.Addr

func (*Listener) Close ¶

func (l *Listener) Close() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL