This type wraps all function calls to OpenDHT. It is a transformer wrapping ReaderT and some other monad (usually Dht).

This type should be used in conjunction with runDhtRunnerM.

Starts a DhtRunner session. This initializes the underlying OpenDHT node and takes care of freeing it before this function terminates.

DhtRunner's function calls don't block the thread they're running on. Therefore, the user should take care of writing appropriate concurrency code for waiting on the underlying node's callback invocation before letting this function terminate. In general, the programmer should not let this function terminate while DHT operations are still susceptible to occur for the application. However, before this function terminates, the node should have been gracefully shutdown by calling it's shutdown method. This will therefore call the user's shutdown callback.

DHT node and security config.

Callback invoked whenever a Value is retrieved on the DHT during a Get (get) request. This callback shall return a boolean indicating whether to stop the Get request or not.

Callback invoked whenever a Value is retrieved on the DHT during a Listen (listen) request. This callback shall be called once when a value is found and once when this same value has expired on the network. Finally, it returns a boolean indicating whether to stop the Listen request or not.

The generic callback invoked for all asynchronous operations when those terminate.

A callback invoked before the Dhtnode is shutdown.

A token used to track Listen requests.

Map of OpToken by InfoHash location.

Get the ID of the underlying DHT node.

Get the public key ID of the DhtRunner.

Access to the current list of values permanently put.

Access to the current listen OpToken map (see listen and cancelListen for more info).

Run the OpenDHT node on a given port.

Run the OpenDHT node on a given port according to the specified configuration.

This module exposes lenses (see Lens) for configuring easily every field of the config data type. Therefore, it's convinient to use & and .~ lens operators in order to set the config. This paired with the Default instance of DhtRunnerConfig make it so that you can start from the default config and build up a specific config in the following manner:

myDhtConfig :: DhtRunnerConfig
myDhtConfig = def
  & logging                          .~ True
  & proxyServer                      .~ "dhtproxy.jami.net:80"
  & dhtConfig.nodeConfig.persistPath .~ "~/.opendht/dht.data"

For the full list of config lenses, see fields of DhtRunnerConfig, DhtSecureConfig, DhtNodeConfig and DhtIdentity. The lists for each data type should follow the respective data type.

Indicates whether the underlying node is running. This should yield True after calling run or runConfig.

Connect to the OpenDHT network before doing any operation.

Note that when _proxyServer is enabled, this has no effect.

Get a Value pointed at by a given hash on the DHT.

Put a Value on the DHT for a given hash.

Cancel a Put request.

The DhtRunnerM monad automatically tracks the permanently put values. In order to cancel one, the user can call getPermanentMetaValues to get the ID of the value he wants to cancel.

Initiate a Listen operation for a given hash.

• The ValueCallback will be invoked once for every value found and once also when each of these same values expire on the DHT.
• While the Listen operation is not cancelled (or the node shutdown), it goes on. Threfore, values subsequently published will be received.
• When listen terminates, an OpToken is added to the map of tokens (listenTokens) for the given hash in the state of DhtRunnerM.

Cancel an on-going Listen operation.

If no Listen request is found for the given arguments, the function returns and does nothing.