kmp-tor
Toggle table of contents
2.2.0
common
jvm
nonJvm
Platform filter
common
jvm
nonJvm
Switch theme
kmp-tor
runtime
io.
matthewnelson.
kmp.
tor.
runtime
Action
Processor
Companion
Start
Daemon
Stop
Daemon
Restart
Daemon
Action
Job
Config
Callback
Defaults
File
ID
Companion
Lifecycle
Destroyable
Tor
Runtime
Event
Companion
Name
Companion
Network
Observer
Companion
Connectivity
Connected
Disconnected
Runtime
Event
Companion
ERROR
EXECUTE
ACTION
CMD
LIFECYCLE
LISTENERS
LOG
DEBUG
INFO
WARN
Notifier
Companion
Observer
Processor
READY
STATE
Tor
Cmd
Job
Tor
Listeners
Tor
Runtime
Builder
Scope
Companion
Environment
Builder
Scope
Companion
Service
Factory
Binder
Initializer
Loader
Tor
State
Daemon
Off
On
Starting
Stopping
Network
Disabled
Enabled
runtime-core
io.
matthewnelson.
kmp.
tor.
runtime.
core
apply()
Destroyable
Companion
Disposable
Companion
Once
Companion
Enqueued
Job
Companion
Execution
Policy
Builder
Scope
Cancellation
Builder
Scope
Companion
Companion
State
Enqueued
Executing
Cancelled
Success
Error
Event
Entries
Observer
Executable
Companion
Once
Companion
It
Block
On
Event
Companion
Executor
Immediate
Main
On
Failure
Companion
On
Success
Companion
This
Block
Tor
Event
ADDRMAP
BUILDTIMEOUT_
SET
BW
CELL_
STATS
CIRC
CIRC_
BW
CIRC_
MINOR
CLIENTS_
SEEN
Companion
CONF_
CHANGED
CONN_
BW
DEBUG
DESCCHANGED
ERR
GUARD
HS_
DESC
HS_
DESC_
CONTENT
INFO
NETWORK_
LIVENESS
NEWCONSENSUS
NEWDESC
NOTICE
NS
Observer
ORCONN
Processor
SIGNAL
STATUS_
CLIENT
STATUS_
GENERAL
STATUS_
SERVER
STREAM
STREAM_
BW
TRANSPORT_
LAUNCHED
WARN
Uncaught
Exception
Handler
Companion
Suppressed
Handler
io.
matthewnelson.
kmp.
tor.
runtime.
core.
config
Configurable
Contract
Configure
Boolean
Configure
Buildable
Configure
Buildable
Try
Configure
Directory
Configure
File
Configure
Interval
Configure
Interval
Msec
Interval
Unit
DAYS
HOURS
MINUTES
MONTHS
SECONDS
WEEKS
Tor
Config
Builder
Scope
Companion
Companion
Tor
Option
_
_
All
Dir
Actions
Private
_
_
Always
Congestion
Control
_
_
Control
Port
_
_
DirPort
_
_
Disable
Predicted
Circuits
_
_
Disable
Signal
Handlers
_
_
DNSPort
_
_
ExtORPort
_
_
Hashed
Control
Session
Password
_
_
HTTPTunnel
Port
_
_
Leave
Streams
Unattached
_
_
Metrics
Port
_
_
NATDPort
_
_
ORPort
_
_
Owning
Controller
FD
_
_
Owning
Controller
Process
_
_
Reload
Torrc
On
SIGHUP
_
_
SbwsExit
_
_
SocksPort
_
_
TransPort
Accel
Dir
Accel
Name
Accounting
Max
Accounting
Rule
Accounting
Start
Address
Address
Disable
IPv6
Allow
Non
RFC953Hostnames
Alternate
Bridge
Authority
Alternate
Dir
Authority
Assume
Reachable
Assume
Reachable
IPv6
Attribute
DIRECTORY
FILE
HIDDEN_
SERVICE
LOGGING
PORT
UNIX_
SOCKET
Auth
Dir
Bad
Exit
Auth
Dir
Bad
Exit
CCs
Auth
Dir
Fast
Guarantee
Auth
Dir
Guard
BWGuarantee
Auth
Dir
Has
IPv6Connectivity
Auth
Dir
Invalid
Auth
Dir
Invalid
CCs
Auth
Dir
List
Bad
Exits
Auth
Dir
List
Middle
Only
Auth
Dir
Max
Servers
Per
Addr
Auth
Dir
Middle
Only
Auth
Dir
Middle
Only
CCs
Auth
Dir
Pin
Keys
Auth
Dir
Reject
Auth
Dir
Reject
CCs
Auth
Dir
Reject
Requests
Under
Load
Auth
Dir
Shared
Randomness
Auth
Dir
Test
Ed25519Link
Keys
Auth
Dir
Test
Reachability
Auth
Dir
Vote
Guard
Auth
Dir
Vote
Guard
Bw
Threshold
Fraction
Auth
Dir
Vote
Guard
Guarantee
Time
Known
Auth
Dir
Vote
Guard
Guarantee
WFU
Auth
Dir
Vote
Stable
Guarantee
Min
Uptime
Auth
Dir
Vote
Stable
Guarantee
MTBF
Authoritative
Directory
Automap
Hosts
On
Resolve
Automap
Hosts
Suffixes
Avoid
Disk
Writes
Bandwidth
Burst
Bandwidth
Rate
Bridge
Bridge
Authoritative
Dir
Bridge
Distribution
Bridge
Password
Bridge
Record
Usage
By
Country
Bridge
Relay
Cache
Directory
Cache
Directory
Group
Readable
Cell
Statistics
Circuit
Build
Timeout
Circuit
Padding
Circuit
Priority
Halflife
Circuits
Available
Timeout
Circuit
Stream
Timeout
Client
Bootstrap
Consensus
Authority
Download
Initial
Delay
Client
Bootstrap
Consensus
Authority
Only
Download
Initial
Delay
Client
Bootstrap
Consensus
Fallback
Download
Initial
Delay
Client
Bootstrap
Consensus
Max
In
Progress
Tries
Client
DNSReject
Internal
Addresses
Client
Onion
Auth
Dir
Client
Only
Client
Prefer
IPv6ORPort
Client
Reject
Internal
Addresses
Client
Transport
Plugin
Client
Use
IPv4
Client
Use
IPv6
Companion
Compiled
Proof
Of
Work
Hash
Conflux
Client
UX
Conflux
Enabled
Conn
Direction
Statistics
Connection
Padding
Conn
Limit
Consensus
Params
Constrained
Sockets
Constrained
Sock
Size
Contact
Info
Control
Port
Control
Port
File
Group
Readable
Control
Port
Write
To
File
Control
Socket
Control
Sockets
Group
Writable
Cookie
Authentication
Cookie
Auth
File
Cookie
Auth
File
Group
Readable
Count
Private
Bandwidth
Data
Directory
Data
Directory
Group
Readable
Dir
Allow
Private
Addresses
Dir
Authority
Dir
Authority
Fallback
Rate
Dir
Cache
Dir
Policy
Dir
Port
Dir
Port
Front
Page
Dir
Req
Statistics
Disable
All
Swap
Disable
Debugger
Attachment
Disable
Network
Disable
OOSCheck
DNSPort
Dormant
Canceled
By
Startup
Dormant
Client
Timeout
Dormant
On
First
Startup
Dormant
Timeout
Disabled
By
Idle
Streams
Dormant
Timeout
Enabled
Do
SCircuit
Creation
Burst
Do
SCircuit
Creation
Defense
Time
Period
Do
SCircuit
Creation
Defense
Type
Do
SCircuit
Creation
Enabled
Do
SCircuit
Creation
Min
Connections
Do
SCircuit
Creation
Rate
Do
SConnection
Connect
Burst
Do
SConnection
Connect
Defense
Time
Period
Do
SConnection
Connect
Rate
Do
SConnection
Defense
Type
Do
SConnection
Enabled
Do
SConnection
Max
Concurrent
Count
Do
SRefuse
Single
Hop
Client
Rendezvous
Download
Extra
Info
Enforce
Distinct
Subnets
Entry
Nodes
Entry
Statistics
Exclude
Exit
Nodes
Exclude
Nodes
Exit
Nodes
Exit
Policy
Exit
Policy
Reject
Local
Interfaces
Exit
Policy
Reject
Private
Exit
Port
Statistics
Exit
Relay
Extend
Allow
Private
Addresses
Extend
By
Ed25519ID
Ext
ORPort
Ext
ORPort
Cookie
Auth
File
Ext
ORPort
Cookie
Auth
File
Group
Readable
Extra
Info
Statistics
Fallback
Dir
Fascist
Firewall
Fetch
Dir
Info
Early
Fetch
Dir
Info
Extra
Early
Fetch
Hid
Serv
Descriptors
Fetch
Server
Descriptors
Fetch
Useless
Descriptors
Geo
IPExclude
Unknown
Geo
IPFile
Geo
IPv6File
Guardfraction
File
Guard
Lifetime
Hardware
Accel
Hashed
Control
Password
Heartbeat
Period
Hidden
Service
Allow
Unknown
Ports
Hidden
Service
Dir
Hidden
Service
Dir
Group
Readable
Hidden
Service
Enable
Intro
Do
SBurst
Per
Sec
Hidden
Service
Enable
Intro
Do
SDefense
Hidden
Service
Enable
Intro
Do
SRate
Per
Sec
Hidden
Service
Export
Circuit
ID
Hidden
Service
Max
Streams
Hidden
Service
Max
Streams
Close
Circuit
Hidden
Service
Non
Anonymous
Mode
Hidden
Service
Num
Introduction
Points
Hidden
Service
Onion
Balance
Instance
Hidden
Service
Port
Hidden
Service
Po
WDefenses
Enabled
Hidden
Service
Po
WQueue
Burst
Hidden
Service
Po
WQueue
Rate
Hidden
Service
Single
Hop
Mode
Hidden
Service
Statistics
Hidden
Service
Version
HSLayer2Nodes
HSLayer3Nodes
HTTPSProxy
HTTPSProxy
Authenticator
HTTPTunnel
Port
IPv6Exit
Keepalive
Period
Keep
Bind
Capabilities
Key
Directory
Key
Directory
Group
Readable
KISTSched
Run
Interval
KISTSock
Buf
Size
Factor
Learn
Circuit
Build
Timeout
Log
Log
Message
Domains
Log
Time
Granularity
Long
Lived
Ports
Mainloop
Stats
Map
Address
Max
Advertised
Bandwidth
Max
Circuit
Dirtiness
Max
Client
Circuits
Pending
Max
Consensus
Age
For
Diffs
Max
Mem
In
Queues
Max
Onion
Queue
Delay
Max
Unparseable
Desc
Size
To
Log
Metrics
Port
Metrics
Port
Policy
Middle
Nodes
Min
Measured
BWs
For
Auth
To
Ignore
Advertised
Min
Uptime
Hid
Serv
Directory
V2
My
Family
NATDPort
New
Circuit
Period
Nickname
Node
Family
No
Exec
Num
CPUs
Num
Directory
Guards
Num
Entry
Guards
Num
Primary
Guards
Offline
Master
Key
ORPort
Outbound
Bind
Address
Outbound
Bind
Address
Exit
Outbound
Bind
Address
OR
Outbound
Bind
Address
PT
Overload
Statistics
Padding
Statistics
Path
Bias
Circ
Threshold
Path
Bias
Drop
Guards
Path
Bias
Extreme
Rate
Path
Bias
Extreme
Use
Rate
Path
Bias
Notice
Rate
Path
Bias
Notice
Use
Rate
Path
Bias
Scale
Threshold
Path
Bias
Scale
Use
Threshold
Path
Bias
Use
Threshold
Path
Bias
Warn
Rate
Paths
Needed
To
Build
Circuits
Per
Conn
BWBurst
Per
Conn
BWRate
Pid
File
Protocol
Warnings
Publish
Hid
Serv
Descriptors
Publish
Server
Descriptor
Reachable
Addresses
Reachable
ORAddresses
Recommended
Client
Versions
Recommended
Server
Versions
Recommended
Versions
Reduced
Circuit
Padding
Reduced
Connection
Padding
Reduced
Exit
Policy
Refuse
Unknown
Exits
Reject
Plaintext
Ports
Relay
Bandwidth
Burst
Relay
Bandwidth
Rate
Rephist
Track
Time
Run
As
Daemon
Safe
Logging
Safe
Socks
Sandbox
Schedulers
Server
DNSAllow
Broken
Config
Server
DNSAllow
Non
RFC953Hostnames
Server
DNSDetect
Hijacking
Server
DNSRandomize
Case
Server
DNSResolv
Conf
File
Server
DNSSearch
Domains
Server
DNSTest
Addresses
Server
Transport
Listen
Addr
Server
Transport
Options
Server
Transport
Plugin
Shutdown
Wait
Length
Signing
Key
Lifetime
Socks4Proxy
Socks5Proxy
Socks5Proxy
Password
Socks5Proxy
Username
Socks
Policy
Socks
Port
Socks
Timeout
SSLKey
Lifetime
Strict
Nodes
Syslog
Identity
Tag
TCPProxy
Testing
Auth
Dir
Time
To
Learn
Reachability
Testing
Auth
Key
Lifetime
Testing
Auth
Key
Slop
Testing
Bridge
Bootstrap
Download
Initial
Delay
Testing
Bridge
Download
Initial
Delay
Testing
Client
Consensus
Download
Initial
Delay
Testing
Client
Download
Initial
Delay
Testing
Client
Max
Interval
Without
Request
Testing
Dir
Auth
Vote
Exit
Testing
Dir
Auth
Vote
Exit
Is
Strict
Testing
Dir
Auth
Vote
Guard
Testing
Dir
Auth
Vote
Guard
Is
Strict
Testing
Dir
Auth
Vote
HSDir
Testing
Dir
Auth
Vote
HSDir
Is
Strict
Testing
Dir
Connection
Max
Stall
Testing
Enable
Cell
Stats
Event
Testing
Enable
Conn
Bw
Event
Testing
Link
Cert
Lifetime
Testing
Link
Key
Slop
Testing
Min
Exit
Flag
Threshold
Testing
Min
Fast
Flag
Threshold
Testing
Min
Time
To
Report
Bandwidth
Testing
Server
Consensus
Download
Initial
Delay
Testing
Server
Download
Initial
Delay
Testing
Signing
Key
Slop
Testing
Tor
Network
Testing
V3Auth
Initial
Dist
Delay
Testing
V3Auth
Initial
Vote
Delay
Testing
V3Auth
Initial
Voting
Interval
Testing
V3Auth
Voting
Start
Offset
Test
Socks
Token
Bucket
Refill
Interval
Track
Host
Exits
Track
Host
Exits
Expire
Trans
Port
Trans
Proxy
Type
Truncate
Log
File
Unix
Socks
Group
Writable
Update
Bridges
From
Authority
Use
Bridges
Use
Default
Fallback
Dirs
Use
Entry
Guards
Use
Guard
Fraction
Use
Microdescriptors
User
V3Auth
Dist
Delay
V3Auth
NIntervals
Valid
V3Authoritative
Directory
V3Auth
Use
Legacy
Key
V3Auth
Vote
Delay
V3Auth
Voting
Interval
V3Bandwidths
File
Vanguards
Lite
Enabled
Versioning
Authoritative
Directory
Virtual
Addr
Network
IPv4
Virtual
Addr
Network
IPv6
Warn
Plaintext
Ports
Tor
Setting
Builder
Scope
Companion
Line
Item
io.
matthewnelson.
kmp.
tor.
runtime.
core.
config.
builder
Builder
Scope
Auto
Boolean
Builder
Scope
HS
Builder
Scope
HSPort
Builder
Scope
Owning
Ctrl
Process
Builder
Scope
Port
Companion
Control
DNS
Flags
Builder
Isolation
Flags
Builder
Socks
Flags
Builder
Unix
HTTPTunnel
Socks
Trans
Builder
Scope
Syslog
Id
Tag
Builder
Scope
Virtual
Addr
Network
IPv4
Network
IPv6
io.
matthewnelson.
kmp.
tor.
runtime.
core.
ctrl
Address
Mapping
Companion
Result
Client
Auth
Entry
Companion
Config
Entry
Hidden
Service
Entry
Companion
Reply
Companion
Error
Companion
Success
OK
Tor
Cmd
Authenticate
Config
Get
Load
Reset
Save
Set
Drop
Guards
Hs
Fetch
Info
Get
Map
Address
Onion
Add
Companion
Delete
Onion
Client
Auth
Add
Remove
View
Companion
Ownership
Drop
Take
Privileged
Processor
Resolve
Set
Events
Signal
Active
Clear
Dns
Cache
Debug
Dormant
Dump
Halt
Heartbeat
New
Nym
Reload
Shutdown
Unprivileged
Processor
io.
matthewnelson.
kmp.
tor.
runtime.
core.
ctrl.
builder
Builder
Scope
Client
Auth
Add
Flags
Builder
Builder
Scope
Onion
Add
Flags
Builder
io.
matthewnelson.
kmp.
tor.
runtime.
core.
key
Address
Key
Private
Public
Auth
Key
Private
Public
ED25519_
V3
Private
Key
Companion
Public
Key
Companion
Key
Private
Public
Key
Type
Address
Auth
X25519
Private
Key
Companion
Public
Key
Companion
io.
matthewnelson.
kmp.
tor.
runtime.
core.
net
Address
IPAddress
Companion
V4
Any
Host
Companion
V6
Any
Host
No
Scope
Companion
IPSocket
Address
Companion
Local
Host
Companion
IPv4
IPv6
Onion
Address
Companion
V3
Companion
Port
Companion
Ephemeral
Companion
HTTP
HTTPS
ZERO
io.
matthewnelson.
kmp.
tor.
runtime.
core.
util
execute
Async()
execute
Sync()
find
Next
Available
Async()
find
Next
Available
Sync()
is
Available
Async()
is
Available
Sync()
to
Inet4Address()
to
Inet6Address()
to
Inet
Address()
to
IPAddress()
to
IPAddress
V4()
to
IPAddress
V6()
runtime-ctrl
io.
matthewnelson.
kmp.
tor.
runtime.
ctrl
Tor
Cmd
Interceptor
Companion
Tor
Ctrl
Factory
runtime-service
io.
matthewnelson.
kmp.
tor.
runtime.
service
Abstract
Tor
Service
UI
Args
Instance
UI
Companion
Config
Factory
Instance
State
Tor
Service
Config
Builder
Scope
Companion
Foreground
Builder
Scope
Companion
UTIL
Tor
Service
UI
Args
Companion
Factory
Notification
Info
Receiver
runtime-service-ui
io.
matthewnelson.
kmp.
tor.
runtime.
service.
ui
Abstract
Kmp
Tor
Service
UIConfig
Companion
Display
Name
FID
String
Res
Text
Companion
Kmp
Tor
Service
UI
Config
Builder
Scope
Factory
Builder
Scope
Kmp
Tor
Service
UIInstance
State
runtime-core
/
io.matthewnelson.kmp.tor.runtime.core.key
/
Key
/
base64OrNull
base64Or
Null
common
jvm
nonJvm
expect
abstract
fun
base64OrNull
(
)
:
String
?
(
source
)
actual
abstract
fun
base64OrNull
(
)
:
String
?
(
source
)
actual
abstract
fun
base64OrNull
(
)
:
String
?
(
source
)