mirror of
https://github.com/cypherstack/stack_wallet.git
synced 2025-01-22 10:34:32 +00:00
docs
This commit is contained in:
parent
b2203a6cc7
commit
ea223ff7cd
1 changed files with 4 additions and 3 deletions
|
@ -12,7 +12,7 @@ class TorService {
|
||||||
Tor? _tor;
|
Tor? _tor;
|
||||||
String? _torDataDirPath;
|
String? _torDataDirPath;
|
||||||
|
|
||||||
/// Current status. Same as that fired on the event bus
|
/// Current status. Same as that fired on the event bus.
|
||||||
TorConnectionStatus get status => _status;
|
TorConnectionStatus get status => _status;
|
||||||
TorConnectionStatus _status = TorConnectionStatus.disconnected;
|
TorConnectionStatus _status = TorConnectionStatus.disconnected;
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ class TorService {
|
||||||
|
|
||||||
/// Getter for the proxyInfo.
|
/// Getter for the proxyInfo.
|
||||||
///
|
///
|
||||||
/// Returns null if disabled on the stack wallet level.
|
/// Throws if Tor is not connected.
|
||||||
({
|
({
|
||||||
InternetAddress host,
|
InternetAddress host,
|
||||||
int port,
|
int port,
|
||||||
|
@ -55,7 +55,8 @@ class TorService {
|
||||||
///
|
///
|
||||||
/// This will start the Tor service and establish a Tor circuit.
|
/// This will start the Tor service and establish a Tor circuit.
|
||||||
///
|
///
|
||||||
/// Throws an exception if the Tor service fails to start.
|
/// Throws an exception if the Tor library was not inited or if the Tor
|
||||||
|
/// service fails to start.
|
||||||
///
|
///
|
||||||
/// Returns a Future that completes when the Tor service has started.
|
/// Returns a Future that completes when the Tor service has started.
|
||||||
Future<void> start() async {
|
Future<void> start() async {
|
||||||
|
|
Loading…
Reference in a new issue