LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Packages Projects Releases 28 Wiki Activity

peer: Correct a few typos in documentation.

Browse source
This commit is contained in:
Dave Collins 2015-10-23 13:41:32 -05:00
parent cbbe3a8bbe
commit aa03d68e1e
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
peer/doc.go
View file

@ -62,13 +62,14 @@ Inbound and Outbound Peers
A peer can either be inbound or outbound. The caller is responsible for A peer can either be inbound or outbound. The caller is responsible for
establishing the connection to remote peers and listening for incoming peers. establishing the connection to remote peers and listening for incoming peers.
This provides high flexibility for things such as using proxies, acting as a This provides high flexibility for things such as connecting via proxies, acting
proxy, creating bride peers, choosing whether to listen for inbound peers, etc. as a proxy, creating bridge peers, choosing whether to listen for inbound peers,
etc.
For outgoing peers, the NewOutboundPeer function must be used to specify the For outgoing peers, the NewOutboundPeer function must be used to specify the
configuration followed by invoking Connect with the net.Conn instance. This configuration followed by invoking Connect with the net.Conn instance. This
start all async I/O goroutines and initiate the initial negotiation process. will start all async I/O goroutines and initiate the initial negotiation
Once that has been completed, the peer is fully functional. process. Once that has been completed, the peer is fully functional.
For inbound peers, the NewInboundPeer function must be used to specify the For inbound peers, the NewInboundPeer function must be used to specify the
configuration and net.Conn instance followed by invoking Start. This will start configuration and net.Conn instance followed by invoking Start. This will start
@ -92,18 +93,18 @@ byte counts.
It is often useful to use closures which encapsulate state when specifying the It is often useful to use closures which encapsulate state when specifying the
callback handlers. This provides a clean method for accessing that state when callback handlers. This provides a clean method for accessing that state when
callbacks are invoked. TODO(davec): Provide example... callbacks are invoked.
Queuing Messages and Inventory Queuing Messages and Inventory
The QueueMessage function provides the fundamental means to send messages to the The QueueMessage function provides the fundamental means to send messages to the
remote peer. As the name implies, this employs a non-blocking queue. A done remote peer. As the name implies, this employs a non-blocking queue. A done
channel which will be notified when the message is actually sent can optionally channel which will be notified when the message is actually sent can optionally
be specified. There are certain message types which are better send using other be specified. There are certain message types which are better sent using other
functions which provide additional functionality. functions which provide additional functionality.
Of special interest are inventory messages. Rather than manually sending MsgInv Of special interest are inventory messages. Rather than manually sending MsgInv
message via Queuemessage, the inventory vectors should be queued using the messages via Queuemessage, the inventory vectors should be queued using the
QueueInventory function. It employs batching and trickling along with QueueInventory function. It employs batching and trickling along with
intelligent known remote peer inventory detection and avoidance through the use intelligent known remote peer inventory detection and avoidance through the use
of a most-recently used algorithm. of a most-recently used algorithm.
@ -146,8 +147,7 @@ raw message bytes using a format similar to hexdump -C.
Bitcoin Improvement Proposals Bitcoin Improvement Proposals
This package supported all BIPS support by the This package supports all BIPS supported by the wire packge.
[wire](https://godoc.org/github.com/btcsuite/btcd/wire#hdr-Bitcoin_Improvement_Proposals) (https://godoc.org/github.com/btcsuite/btcd/wire#hdr-Bitcoin_Improvement_Proposals)
package.
*/ */
package peer package peer