protocol

Documentation

Overview

Package protocol defines types for the clock protocol.

Index

• Variables
• type Clock
  • func NewClock(host Host, timeout time.Duration) *Clock
  • func (c *Clock) ProtocolID() protocol.ID
  • func (c *Clock) RemoteTime(ctx context.Context, pid peer.ID) (*time.Time, error)
  • func (c *Clock) StreamHandler(ctx context.Context, stream inet.Stream)
  • func (c *Clock) Wait()
• type Host

Variables

var ProtocolID = protocol.ID("/indigo/node/clock/v1.0.0")

ProtocolID is the protocol ID of the protocol.

Types

type Clock

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

Clock implements the clock protocol.

func NewClock

func NewClock(host Host, timeout time.Duration) *Clock

NewClock creates a new clock.

func (*Clock) ProtocolID

func (c *Clock) ProtocolID() protocol.ID

ProtocolID returns this protocol ID

func (*Clock) RemoteTime

func (c *Clock) RemoteTime(ctx context.Context, pid peer.ID) (*time.Time, error)

RemoteTime asks a peer for its time.

func (*Clock) StreamHandler

func (c *Clock) StreamHandler(ctx context.Context, stream inet.Stream)

StreamHandler handles incoming messages from a peer.

func (*Clock) Wait

func (c *Clock) Wait()

Wait waits for all the streams to be closed.

type Host

type Host = ihost.Host

Host represents an Indigo Node host.