https://github.com/quark-zju/childprocess-server

Manage and interact with processes, remotely.
https://github.com/quark-zju/childprocess-server

Last synced: 3 months ago
JSON representation

Manage and interact with processes, remotely.

• Host: GitHub
• URL: https://github.com/quark-zju/childprocess-server
• Owner: quark-zju
• License: mit
• Created: 2013-03-30T16:22:17.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-03-04T23:40:39.000Z (about 1 year ago)
• Last Synced: 2025-02-08T09:24:13.770Z (4 months ago)
• Language: Ruby
• Size: 8.79 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# childprocess-server

[![Gem Version](https://badge.fury.io/rb/childprocess-server.png)](http://badge.fury.io/rb/childprocess-server)

[![Build Status](https://travis-ci.org/quark-zju/childprocess-server.png?branch=master)](https://travis-ci.org/quark-zju/childprocess-server)

[![Code Climate](https://codeclimate.com/github/quark-zju/childprocess-server.png)](https://codeclimate.com/github/quark-zju/childprocess-server)

Manage and interact with processes, remotely (via dRuby).

## Installation

```bash

gem install childprocess-server

```

## Usage

### Standalone

```ruby

require 'childprocess-server'

server = ChildProcess::Server.new

# Run a process

pid = server.launch('sleep', '1000')

server.alive?(pid) # => true

server.stop(pid)

server.alive?(pid) # => false

# Run 'echo', get output

pid = server.launch('echo', 'hello')

server.read_output(pid) # => "hello\n"

server.alive?(pid) # => false

# Run 'cat', write stdin interactively

pid = server.launch('cat')

server.write_input(pid, "foo\n")

server.read_output(pid) # => "foo\n"

server.write_input(pid, "bar\n")

server.read_output(pid) # => "foo\nbar\n"

server.stop(pid)

# List all process ids managed

# Note: exited processes are also listed.

server.list_pids # => [ ... ]

# Clean up

server.clean_up

server.list_pids # => []

```

### Client / Server

```ruby

DRB_URI = 'drbunix://tmp/a.socket'

# Server side

ChildProcess::Server.new.start_service(DRB_URI) # will block by default

# Client side

server = ChildProcess::Server.connect(DRB_URI)

pid = server.launch('sort', '-n')

server.write_input(pid, "20\n10\n2\n1\n")

server.read_output(pid) # => "1\n2\n10\n20\n"

```

## Notes

* This library is thread-safe.

* This library does not have authentic feature.

  Set file system permissions or firewall for security.

* After `stop`, output can still be read using `read_output`,

  because outputs are stored in temporary files.

  Use `clean_up` to delete them immediately.

  Otherwise they are deleted when server exits.

* If `read_output` or `write_input` encounters errors,

  they just return `nil` instead of raising an error.