gateway

Documentation

Overview

This package starts up the daemon and everything else. It contains the entry point for Android bindings: the Run() function.

Index

• func IsRunning() bool
• func Run(repoPath, gatewayPort, interfaces string)
• func RunSynchronous(repoPath, gatewayPort, interfaces string) int
• func Stop()

Functions

func IsRunning

func IsRunning() bool

IsRunning returns a bool indicating whether the daemon is running.

func Run

func Run(repoPath, gatewayPort, interfaces string)

Run starts up the daemon and returns immediately.

repoPath is a path to a directory for the IPFS repo. It doesn't need to exist.

interfaces is a newline-delimited list of network interface definitions. It is only needed on Android. See get_interfaces.java for code of how this string is generated.

gatewayPort is the TCP port the gateway runs on.

func RunSynchronous

func RunSynchronous(repoPath, gatewayPort, interfaces string) int

RunSynchronous is like Run but returns an exit code greater than 0 if there are any errors. It does not return unless there is an error and the daemon has stopped.

func Stop

func Stop()

Stop stops the daemon within over 2 seconds. It does a graceful shutdown.