package
0.0.0-20250225105205-8289a55d8107
Repository: https://github.com/mysteriumnetwork/node.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DefaultConfig returns default params.
NewInstance creates new instance of the service.
NewManager creates new instance of pluggable instances manager.
NewPool returns a empty service pool.
NewRegistry creates a registry of pluggable services.
NewSession creates a blank new session with an ID.
NewSessionManager returns new session SessionManager.
NewSessionPool initiates new session storage.

# Variables

ErrNoSuchInstance represents the error when we're stopping an instance that does not exist.
ErrorInvalidProposal is validation error then invalid proposal requested for session creation.
ErrorLocation error indicates that action (i.e.
ErrorSessionNotExists returned when consumer tries to destroy session that does not exists.
ErrorWrongSessionOwner returned when consumer tries to destroy session that does not belongs to him.
ErrUnsupportedAccessPolicy indicates that manager tried to create service with unsupported access policy.
ErrUnsupportedServiceType indicates that manager tried to create an unsupported service type.

# Structs

Cleaner cleans up when service is stopped.
Config contains common configuration options for session manager.
ConfigParams session configuration parameters.
FindOpts provides fields to search sessions.
Instance represents a run service.
KeepAliveConfig contains keep alive options.
Manager entrypoint which knows how to start pluggable Mysterium instances.
Pool is responsible for supervising running instances.
Registry holds all pluggable services.
Session structure holds all required information about current session between service consumer and provider.
SessionManager knows how to start and provision session.
SessionPool maintains all current sessions in memory.

# Interfaces

ConfigProvider is able to handle config negotiations.
Discovery registers the service to the discovery api periodically.
NATEventGetter lets us access the last known traversal event.
Options represents any type of options for pluggable service.
PaymentEngine is responsible for interacting with the consumer in regard to payments.
PriceValidator allows to validate prices against those in discovery.
PromiseProcessor processes promises at provider side.
Publisher is responsible for publishing given events.
Service interface represents pluggable Mysterium service.
ServiceConfiguration defines service configuration from underlying transport mechanism to be passed to remote party should be serializable to json format.
SessionStorage keeps sessions and allows removing them by proposal id.

# Type aliases

DestroyCallback cleanups session.
DiscoveryFactory initiates instance which is able announce service discoverability.
ID represent unique identifier of the running service.
IDGenerator defines method for session id generation.
PaymentEngineFactory creates a new instance of payment engine.
RegistryFactory initiates instance which is able to serve.
WaitForNATHole blocks until NAT hole is punched towards consumer through local NAT or until hole punching failed.