i2pcontrol

README

go-i2pcontrol

An easy-to-use library for the i2pcontrol rpc interface.

Documentation

Index

• Variables
• func Authenticate(password string) (int, error)
• func BuildRequestTime() (float64, error)
• func Call(method string, params interface{}) (map[string]interface{}, error)
• func ClientBuildSuccess() (int, error)
• func Echo(echo string) (string, error)
• func ExploratoryBuildExpire() (int, error)
• func ExploratoryBuildExpirePercentage() (int, error)
• func ExploratoryBuildReject() (int, error)
• func ExploratoryBuildRejectPercentage() (int, error)
• func ExploratoryBuildSuccess() (int, error)
• func ExploratoryBuildSuccessPercentage() (int, error)
• func FindUpdates() (bool, error)
• func IncomingBW() (int, error)
• func Initialize(host, port, path string)
• func InitializeWithSelfSignedCert(host, port, path, cert string) error
• func KnownPeers() (int, error)
• func NetStatus() (string, error)
• func OutgoingBw() (int, error)
• func ParticipatingAverageTunnels() (int, error)
• func ParticipatingHourAverageTunnels() (int, error)
• func ParticipatingTunnels() (int, error)
• func RateStat(Stat string, Period int) (int, error)
• func RateStatExact(Stat string, Period int) (float64, error)
• func ReceiveBps() (int, error)
• func ReceiveBpsHourAverage() (int, error)
• func Reseeding() (bool, error)
• func Restart() (string, error)
• func RestartGraceful() (string, error)
• func SendBps() (int, error)
• func SendBpsHourAverage() (int, error)
• func Shutdown() (string, error)
• func ShutdownGraceful() (string, error)
• func Status() (string, error)
• func UpTime() (int64, error)
• func Update() (string, error)
• func Upnp() (string, error)
• func Version() (string, error)

Variables

var (
	RPCOpts *jsonrpc.RPCClientOpts
)

Functions

func Authenticate

func Authenticate(password string) (int, error)

Authenticate to the RPC API with a password

func BuildRequestTime

func BuildRequestTime() (float64, error)

func Call

func Call(method string, params interface{}) (map[string]interface{}, error)

Call an RPC method with params

func ClientBuildSuccess

func ClientBuildSuccess() (int, error)

func Echo

func Echo(echo string) (string, error)

Echo test the API

func ExploratoryBuildExpire

func ExploratoryBuildExpire() (int, error)

func ExploratoryBuildExpirePercentage

func ExploratoryBuildExpirePercentage() (int, error)

func ExploratoryBuildReject

func ExploratoryBuildReject() (int, error)

func ExploratoryBuildRejectPercentage

func ExploratoryBuildRejectPercentage() (int, error)

func ExploratoryBuildSuccess

func ExploratoryBuildSuccess() (int, error)

func ExploratoryBuildSuccessPercentage

func ExploratoryBuildSuccessPercentage() (int, error)

func FindUpdates

func FindUpdates() (bool, error)

FindUpdates pings the server to check for updates

func IncomingBW

func IncomingBW() (int, error)

Incoming bandwidth per second

func Initialize

func Initialize(host, port, path string)

Initialize set up the rpcClient with the specified host, port, and path

func InitializeWithSelfSignedCert

func InitializeWithSelfSignedCert(host, port, path, cert string) error

InitializeWithSelfSignedCert will set up an rpcClient which will accept a self-signed certificate, at the path speciied by cert.

func KnownPeers

func KnownPeers() (int, error)

All the known peers

func NetStatus

func NetStatus() (string, error)

NetStatus queries the status of the network connection

func OutgoingBw

func OutgoingBw() (int, error)

Outgoing bandwidth per second

func ParticipatingAverageTunnels

func ParticipatingAverageTunnels() (int, error)

func ParticipatingHourAverageTunnels

func ParticipatingHourAverageTunnels() (int, error)

func ParticipatingTunnels

func ParticipatingTunnels() (int, error)

ParticipatingTunnels gets the number of participating tunnels the router has currently

func RateStat

func RateStat(Stat string, Period int) (int, error)

RateStat executes a GetRate call

func RateStatExact

func RateStatExact(Stat string, Period int) (float64, error)

func ReceiveBps

func ReceiveBps() (int, error)

func ReceiveBpsHourAverage

func ReceiveBpsHourAverage() (int, error)

func Reseeding

func Reseeding() (bool, error)

Reseeding checks if the I2P Router is reseeding

func Restart

func Restart() (string, error)

Restart the router immediately

func RestartGraceful

func RestartGraceful() (string, error)

RestartGraceful initiates a graceful restart, which will occur in around 11 minutes.

func SendBps

func SendBps() (int, error)

func SendBpsHourAverage

func SendBpsHourAverage() (int, error)

func Shutdown

func Shutdown() (string, error)

Shutdown the router immediately

func ShutdownGraceful

func ShutdownGraceful() (string, error)

Shutdown initiates a graceful restart, which will occur in around 11 minutes.

func Status

func Status() (string, error)

Status queries the status of the router

func UpTime

func UpTime() (int64, error)

Uptime of the router

func Update

func Update() (string, error)

Starts an update.

func Upnp

func Upnp() (string, error)

Checks our UPnp

func Version

func Version() (string, error)

Gets the current router version