router

func (*Router) Addr ¶

func (r *Router) Addr() net.Addr

Addr returns the local address of the node in the form of a `types.PublicKey`.

func (*Router) Close ¶

func (r *Router) Close() error

Close will stop the Pinecone node. Once this has been called, the node cannot be restarted or reused.

func (*Router) Connect ¶

func (r *Router) Connect(conn net.Conn, options ...ConnectionOption) (types.SwitchPortID, error)

Connect takes a connection and attaches it to the switch as a peering. This function takes one or more ConnectionOptions to configure the peer. If no ConnectionPublicKey is specified, the connection will autonegotiate with the remote peer to exchange public keys and version/capability information.

func (*Router) Coords ¶

func (r *Router) Coords() types.Coordinates

func (*Router) Disconnect ¶

func (r *Router) Disconnect(i types.SwitchPortID, err error)

Disconnect will disconnect whatever is connected to the given port number on the Pinecone node. The peering will no longer be used and the underlying connection will be closed.

func (*Router) InjectPacketFilter ¶

func (r *Router) InjectPacketFilter(fn FilterFn)

func (*Router) IsConnected ¶

func (r *Router) IsConnected(key types.PublicKey, zone string) bool

IsConnected returns true if the node is connected within the given zone, or false otherwise.

func (*Router) LocalAddr ¶

func (r *Router) LocalAddr() net.Addr

LocalAddr returns a net.Addr containing the public key of the node for SNEK routing.

func (*Router) ManholeHandler ¶

func (r *Router) ManholeHandler(w http.ResponseWriter, req *http.Request)

func (*Router) NextHop ¶

func (r *Router) NextHop(from net.Addr, frameType types.FrameType, dest net.Addr) net.Addr

func (*Router) PeerCount ¶

func (r *Router) PeerCount(peertype int) (count int)

PeerCount returns the number of nodes that are directly connected to this Pinecone node.

func (*Router) Peers ¶

func (r *Router) Peers() []PeerInfo

func (*Router) PrivateKey ¶

func (r *Router) PrivateKey() types.PrivateKey

PrivateKey returns the private key of the node.

func (*Router) PublicKey ¶

func (r *Router) PublicKey() types.PublicKey

PublicKey returns the public key of the node.

func (*Router) ReadFrom ¶

func (r *Router) ReadFrom(p []byte) (n int, addr net.Addr, err error)

ReadFrom reads the next packet that was delivered to this node over the Pinecone network. Only traffic frames will be returned here (not protocol frames). The returned address will either be a `types.PublicKey` (if the frame was delivered using SNEK routing) or `types.Coordinates` (if the frame was delivered using tree routing).

func (*Router) SetDeadline ¶

func (r *Router) SetDeadline(t time.Time) error

SetDeadline is not implemented.

func (*Router) SetReadDeadline ¶

func (r *Router) SetReadDeadline(t time.Time) error

func (*Router) SetWriteDeadline ¶

func (r *Router) SetWriteDeadline(t time.Time) error

SetWriteDeadline is not implemented.

func (*Router) Subscribe ¶

func (r *Router) Subscribe(ch chan<- events.Event)

Subscribe registers a subscriber to this node's events

func (*Router) WriteTo ¶

func (r *Router) WriteTo(p []byte, addr net.Addr) (n int, err error)

WriteTo sends a packet into the Pinecone network. The packet will be sent as a traffic packet. The supplied net.Addr will dictate the method used to route the packet — the address should be a `types.PublicKey` for SNEK routing or `types.Coordinates` for tree routing. Supplying an unsupported address type will result in a `*net.AddrError` being returned.