Struct ConnectWithPrefs

pub struct ConnectWithPrefs {
    pub target: TorAddr,
    pub prefs: StreamPrefs,
}

Available on crate feature rpc only.

RPC special method: make a connection to a chosen address and preferences.

This method has no method name, and is not invoked by an RPC session directly. Instead, it is invoked in response to a SOCKS request. It receives its target from the SOCKS DEST field. The isolation information in its SrreamPrefs, if any, is taken from the SOCKS username/password. Other information in the StreamPrefs is inferred from the SOCKS port configuration in the usual way.

When this method returns successfully, the proxy code sends a SOCKS reply indicating success, and links the returned DataStream with the application’s incoming socket, copying data back and forth. (The `DataStream`` need not actually be connected at this point; an in-progress connection will work fine. Tor calls such streams, which report readiness before receiving a CONNECTED, “optimistic”.)

If instead this method returns an error, the error is either used to generate a SOCKS error code,

Note 1: in the future, this method will likely be used to integrate RPC data streams with other proxy types other than SOCKS. When this happens, we will specify how those proxy types will provide target and prefs.

Note 2: This has to be a special method, because it needs to return a DataStream, which can’t be serialized.

TODO RPC: The above documentation still isn’t quite specific enough, and a lot of it belongs in socks.rs where it could explain how a SOCKS request is interpreted and converted into a ConnectWithPrefs call. See https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/2373#note_3071833 for discussion.

Fields

target: TorAddr

The target address

prefs: StreamPrefs

The stream preferences implied by the SOCKS connect request.

Trait Implementations

impl Debug for ConnectWithPrefs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DynMethod for ConnectWithPrefs

fn invoke_without_dispatch( &self, ctx: Arc<dyn Context>, obj_id: &ObjectId, ) -> Result<Pin<Box<dyn Future<Output = Result<Box<dyn Serialize + Send>, RpcError>> + Send>>, InvokeError>

Invoke a method while bypassing the regular RPC method dispatch system.

impl Method for ConnectWithPrefs

type Output = Result<DataStream, Box<dyn ClientConnectionError>>

A type returned by this method.

type Update = NoUpdates

A type sent by this method on updates.