p2pclient

package

v0.6.5 Latest Latest Go to latest Published: Mar 29, 2024 License: Apache-2.0, MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ipni/go-libipni

Links

Open Source Insights

Documentation ¶

Overview ¶

Package p2pclient provides general libp2p client functionality

This package supplies functionality to communicate raw data with libp2p peers. It is useful for building higher-level clients that process data which is sent and received by this package.

Index ¶

Variables
type Client
- func New(p2pHost host.Host, peerID peer.ID, protoID protocol.ID) (*Client, error)
type Response
- func (r *Response) Close()

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrReadTimeout = fmt.Errorf("timed out reading response")

ErrReadTimeout is an error that occurs when no message is read within the timeout period.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

Client is responsible for sending requests and receiving responses to and from libp2p peers. Each instance of Client communicates with a single peer using a single protocolID.

func New ¶

func New(p2pHost host.Host, peerID peer.ID, protoID protocol.ID) (*Client, error)

New creates a new Client that communicates with a specific peer identified by protocolID. If host is nil, then one is created.

func (*Client) Close ¶

func (c *Client) Close() error

Close resets and closes the network stream if one exists.

func (*Client) Connect ¶

func (c *Client) Connect(ctx context.Context, hostname string) error

Connect connects the client to the host at the location specified by hostname. The value of hostname is a host or host:port, where the host is a hostname or IP address.

func (*Client) ConnectAddrs ¶

func (c *Client) ConnectAddrs(ctx context.Context, maddrs ...multiaddr.Multiaddr) error

func (*Client) Self ¶

func (c *Client) Self() peer.ID

Self return the peer ID of this client.

func (*Client) SendMessage ¶

func (c *Client) SendMessage(ctx context.Context, msg proto.Message) error

SendMessage sends out a message.

func (*Client) SendRequest ¶

func (c *Client) SendRequest(ctx context.Context, msg proto.Message) *Response

SendRequest sends out a request and reads a response.

type Response ¶

type Response struct {
	Data []byte
	Err  error
	// contains filtered or unexported fields
}

Response is returned by SendRequest and contains the response to the request. It is the caller's responsibility to call Response.Close() after reading the data, to free the message buffer.

func (*Response) Close ¶

func (r *Response) Close()

Close frees the message buffer that holds the response data.

Source Files ¶

View all Source files

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