Documentation
¶
Overview ¶
Package onions is not really a package but inside it is all the onion and other message type codec definitions that seemed to make sense to group here.
todo: this kinda should be divided up into ads, onions and misc things, and other codec definitions elsewhere also grouped appropriately.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adaddress defines the message format that provides the network multi-address of a peer with a given public identity key.
|
Package adaddress defines the message format that provides the network multi-address of a peer with a given public identity key. |
|
Package adintro defines a message type that provides information about an introduction point for a hidden service.
|
Package adintro defines a message type that provides information about an introduction point for a hidden service. |
|
Package adload provides a message type that provides information about the current load level of a node identified by its public key.
|
Package adload provides a message type that provides information about the current load level of a node identified by its public key. |
|
Package adpeer provides a message type that provides the base information, identity key and relay rate for an Indra relay.
|
Package adpeer provides a message type that provides the base information, identity key and relay rate for an Indra relay. |
|
Package adproto is an abstract message type that composes the common elements of all ads - nonce ID, public key (identity), expiry and signature.
|
Package adproto is an abstract message type that composes the common elements of all ads - nonce ID, public key (identity), expiry and signature. |
|
Package adservices provides a message type for advertising what kinds of exit services a peer provides to clients, including the port number and the cost per megabyte of data.
|
Package adservices provides a message type for advertising what kinds of exit services a peer provides to clients, including the port number and the cost per megabyte of data. |
|
Package balance provides an onion layer message that comes in response to a getbalance query, informing the client of the balance of a session, identified by the getbalance nonce.ID.
|
Package balance provides an onion layer message that comes in response to a getbalance query, informing the client of the balance of a session, identified by the getbalance nonce.ID. |
|
Package confirmation provides an onion message type that simply returns a confirmation for an associated nonce.ID of a previous message that we want to confirm was received.
|
Package confirmation provides an onion message type that simply returns a confirmation for an associated nonce.ID of a previous message that we want to confirm was received. |
|
Package consts is a series of constants common to several different onion message types.
|
Package consts is a series of constants common to several different onion message types. |
|
Package crypt is an onion message layer which specifies that subsequent content will be encrypted.
|
Package crypt is an onion message layer which specifies that subsequent content will be encrypted. |
|
Package delay provides an onion message type that allows a client to specify an arbitrary delay time before processing the rest of an onion message.
|
Package delay provides an onion message type that allows a client to specify an arbitrary delay time before processing the rest of an onion message. |
|
Package end is a null tombstone type onion message that indicates there is no more data in the onion (used with encoding only).
|
Package end is a null tombstone type onion message that indicates there is no more data in the onion (used with encoding only). |
|
Package exit is an onion message type that contains a payload intended to be forwarded to the exit service of a relay.
|
Package exit is an onion message type that contains a payload intended to be forwarded to the exit service of a relay. |
|
Package forward is an onion message layer that specifies a single redirection for the remainder of the onion.
|
Package forward is an onion message layer that specifies a single redirection for the remainder of the onion. |
|
Package getbalance provides an onion message layer type that makes a request for the current balance of a session.
|
Package getbalance provides an onion message layer type that makes a request for the current balance of a session. |
|
Package hiddenservice provides a message type for hidden services to send to designated introducer relays.
|
Package hiddenservice provides a message type for hidden services to send to designated introducer relays. |
|
Package introquery is an onion message that verifies a relay is an introducer for a given hidden service, returning its adintro.Ad.
|
Package introquery is an onion message that verifies a relay is an introducer for a given hidden service, returning its adintro.Ad. |
|
Package message provides a message type for sending a message to a hidden service, or back to a hidden service client.
|
Package message provides a message type for sending a message to a hidden service, or back to a hidden service client. |
|
Package ont defines interfaces for the engine: Ngin and Onion coding.Codec subtypes, and some helpers that use the abstraction.
|
Package ont defines interfaces for the engine: Ngin and Onion coding.Codec subtypes, and some helpers that use the abstraction. |
|
Package ready provides an onion message type that is sent via client provided routing header back to the client after an introducer forwards a route message to initiate a hidden service connection.
|
Package ready provides an onion message type that is sent via client provided routing header back to the client after an introducer forwards a route message to initiate a hidden service connection. |
|
Package reg is a registry for message types that implement the coding.Codec interface.
|
Package reg is a registry for message types that implement the coding.Codec interface. |
|
Package response provides a message type in response to an Exit message.
|
Package response provides a message type in response to an Exit message. |
|
Package reverse provides a message type for the forwarding directions in a 3 layer routing header.
|
Package reverse provides a message type for the forwarding directions in a 3 layer routing header. |
|
Package route provides an onion mesage type that initiates a hidden service connection with a designated introducer who holds the forwarding routing header to send the route message to a hidden service, who replies to the client using their reply routing header with a ready message.
|
Package route provides an onion mesage type that initiates a hidden service connection with a designated introducer who holds the forwarding routing header to send the route message to a hidden service, who replies to the client using their reply routing header with a ready message. |
|
Package session provides an onion message type that delivers the two session private keys to be associated with a session, for which the hash of the secrets was used as the payment preimage for starting a session.
|
Package session provides an onion message type that delivers the two session private keys to be associated with a session, for which the hash of the secrets was used as the payment preimage for starting a session. |
Click to show internal directories.
Click to hide internal directories.