face

package

v1.5.2 Latest Latest Go to latest Published: Apr 27, 2025 License: MIT Imports: 10 Imported by: 2

Details

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

Repository

github.com/named-data/ndnd

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

type DummyFace
- func NewDummyFace() *DummyFace
type StreamFace
- func NewStreamFace(network string, addr string, local bool) *StreamFace
type WebSocketFace
- func NewWebSocketFace(url string, local bool) *WebSocketFace

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DummyFace ¶ added in v1.5.0

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

func NewDummyFace ¶ added in v1.5.0

func NewDummyFace() *DummyFace

func (*DummyFace) Close ¶ added in v1.5.0

func (f *DummyFace) Close() error

func (*DummyFace) Consume ¶ added in v1.5.0

func (f *DummyFace) Consume() (enc.Buffer, error)

Consume consumes a packet from the engine

func (*DummyFace) FeedPacket ¶ added in v1.5.0

func (f *DummyFace) FeedPacket(pkt enc.Buffer) error

FeedPacket feeds a packet for the engine to consume

func (*DummyFace) IsLocal ¶ added in v1.5.0

func (f *DummyFace) IsLocal() bool

func (*DummyFace) IsRunning ¶ added in v1.5.0

func (f *DummyFace) IsRunning() bool

func (*DummyFace) OnDown ¶ added in v1.5.0

func (f *DummyFace) OnDown(onDown func()) (cancel func())

func (*DummyFace) OnError ¶ added in v1.5.0

func (f *DummyFace) OnError(onError func(err error))

func (*DummyFace) OnPacket ¶ added in v1.5.0

func (f *DummyFace) OnPacket(onPkt func(frame []byte))

func (*DummyFace) OnUp ¶ added in v1.5.0

func (f *DummyFace) OnUp(onUp func()) (cancel func())

func (*DummyFace) Open ¶ added in v1.5.0

func (f *DummyFace) Open() error

func (*DummyFace) Send ¶ added in v1.5.0

func (f *DummyFace) Send(pkt enc.Wire) error

func (*DummyFace) String ¶ added in v1.5.0

func (f *DummyFace) String() string

type StreamFace ¶

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

StreamFace is a face that uses a stream connection.

func NewStreamFace ¶

func NewStreamFace(network string, addr string, local bool) *StreamFace

func (*StreamFace) Close ¶

func (f *StreamFace) Close() error

func (*StreamFace) IsLocal ¶

func (f *StreamFace) IsLocal() bool

func (*StreamFace) IsRunning ¶

func (f *StreamFace) IsRunning() bool

func (*StreamFace) OnDown ¶ added in v1.5.0

func (f *StreamFace) OnDown(onDown func()) (cancel func())

func (*StreamFace) OnError ¶ added in v1.5.0

func (f *StreamFace) OnError(onError func(err error))

func (*StreamFace) OnPacket ¶ added in v1.5.0

func (f *StreamFace) OnPacket(onPkt func(frame []byte))

func (*StreamFace) OnUp ¶ added in v1.5.0

func (f *StreamFace) OnUp(onUp func()) (cancel func())

func (*StreamFace) Open ¶

func (f *StreamFace) Open() error

func (*StreamFace) Send ¶

func (f *StreamFace) Send(pkt enc.Wire) error

func (*StreamFace) String ¶ added in v1.5.0

func (f *StreamFace) String() string

type WebSocketFace ¶

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

func NewWebSocketFace ¶

func NewWebSocketFace(url string, local bool) *WebSocketFace

func (*WebSocketFace) Close ¶

func (f *WebSocketFace) Close() error

func (*WebSocketFace) IsLocal ¶

func (f *WebSocketFace) IsLocal() bool

func (*WebSocketFace) IsRunning ¶

func (f *WebSocketFace) IsRunning() bool

func (*WebSocketFace) OnDown ¶ added in v1.5.0

func (f *WebSocketFace) OnDown(onDown func()) (cancel func())

func (*WebSocketFace) OnError ¶ added in v1.5.0

func (f *WebSocketFace) OnError(onError func(err error))

func (*WebSocketFace) OnPacket ¶ added in v1.5.0

func (f *WebSocketFace) OnPacket(onPkt func(frame []byte))

func (*WebSocketFace) OnUp ¶ added in v1.5.0

func (f *WebSocketFace) OnUp(onUp func()) (cancel func())

func (*WebSocketFace) Open ¶

func (f *WebSocketFace) Open() error

func (*WebSocketFace) Send ¶

func (f *WebSocketFace) Send(pkt enc.Wire) error

func (*WebSocketFace) String ¶ added in v1.5.0

func (f *WebSocketFace) String() string

Source Files ¶

View all Source files

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