Files
opencloud/ocis/pkg/runtime/README.md
Bishop Clark 155baa83cb Update README.md
adjective order
2022-07-09 12:45:02 -07:00

69 lines
1.5 KiB
Markdown

# ownCloud Infinite Scale: Runtime
Pman is a slim utility library for supervising long-running processes. It can be [embedded](https://github.com/owncloud/OCIS/blob/ea2a2b328e7261ed72e65adf48359c0a44e14b40/OCIS/pkg/runtime/runtime.go#L84) or used as a cli command.
When used as a CLI command it relays actions to a running runtime.
## Usage
Start a runtime
```go
package main
import "github.com/owncloud/ocis/ocis/pkg/runtime/service"
func main() {
service.Start()
}
```
![start runtime](https://imgur.com/F67hgQk.gif)
Start sending messages
![message runtime](https://imgur.com/O71RlsJ.gif)
## Example
```go
package main
import (
"fmt"
"github.com/owncloud/ocis/ocis/pkg/runtime/process"
"github.com/owncloud/ocis/ocis/pkg/runtime/service"
"github.com/rs/zerolog/log"
"os"
"os/signal"
"syscall"
"time"
)
func main() {
s := service.NewService()
var c = make(chan os.Signal, 1)
var o int
signal.Notify(c, syscall.SIGINT, syscall.SIGTERM)
if err := s.Start(process.NewProcEntry("ocs", nil, "ocs"), &o); err != nil {
os.Exit(1)
}
time.AfterFunc(3*time.Second, func() {
var acc = "ocs"
fmt.Printf(fmt.Sprintf("shutting down service: %s", acc))
if err := s.Controller.Kill(&acc); err != nil {
log.Fatal()
}
os.Exit(0)
})
for {
select {
case <-c:
return
}
}
}
```
Run the example above with `RUNTIME_KEEP_ALIVE=true` and with no `RUNTIME_KEEP_ALIVE` set to see its behavior. It requires an [oCIS binary](https://github.com/owncloud/ocis/releases) present in your `$PATH` for it to work.