#Overview The streamer package provides an easy to use way to stream files from one location to an other via ZMQ. It contains 2 applications, a simple receiver and a stream server. The stream server

Usage

Receiver

The file receiver can be started via the receiver script located in the bin folder. The receiver will store the files relatively to the directory from which the receiver script is started.

The usage of receiver is as follows:

Usage: receiver
 -h         Help
 -i <interface>   Interface to bind ZMQ socket
 -p <arg>   Source port (default: 8888)
 -s <arg>   Source address [required]
 -d <path>	Base path [required]

Stream Server

The stream server can be started via the 'streamer' script located in the bin folder.

The usage of the streamer is as follows:

Usage: streamer
 -h         Help
 -p <arg>   Webserver port (default: 8080)
 -d <path>	Base path for monitoring files [required]

Stream Server - UI

Streamer comes with a web UI. One can use this UI to list and manage current streams. The web UI is accessible on http://<host>:8080/static/ . Note: It is important to have the last / inside the url!

Development

Build

The project is build via Gradle. It can be easily build via

./gradlew build

Notes: You don't have to have gradle installed on your machine. All you need is a Java JDK version >= 1.7 .

The installation zip package can be build by

./gradlew distribution

Afterwards the installable zip file is available in the build/distributions directory.

REST API

Get version of server

GET version
200 - 0.0.0

Get list of active streams

GET stream
Accept: application/json

200 - [ ]

Register for stream changes

GET events

200 - Server Send Event (SSE) stream.

---

Messages currently supported:

• stream - list of current streams

  [ ]
  

****

Start new stream

PUT stream/{id}

{ "source":[ { "searchPath":"Desktop/test/one", "searchPattern":"glob:*", "destinationPath":"bli", "numberOfImages":1, "streamExsitingFiles":false } ]

"header":{},

"method":"push/pull",
"port":8888,
"wipeFile":"false"

}

204 Stream created

* All keys are optional except searchPath
* Supported methods are `push/pull` and `pub/sub`


Terminate stream

DELETE stream/{id}

200 - { "status": { "sendCount": 4 }, "configuration": { "source": [ { "searchPath": "test", "searchPattern": "glob:*", "destinationPath": "", "numberOfImages": 0, "streamExistingFiles": true } ], "header": null, "port": 8888, "highWaterMark": 1000, "wipeFile": true, "method": "pub/sub" } }

 * Returns status information of the stream, i.e. number of images transmitted, ...


Get Stream information/status

GET stream/{id}

404 Not found - If stream does not exist (anymore) 200 - { "status": { "sendCount": 0 }, "configuration": { "source":[ "searchPath": "/Users/ebner/Desktop/test", "searchPattern": "glob:*", "destinationPath": "", "numberOfImages": 0, "streamExsitingFiles":false ] "header": null, "method":"push/pull", "port": 8888, "highWaterMark": 1000, "wipeFile": true } }

Get exsiting files in the streamers basedir

GET basedir/files

200 [ fileA.cbf, fileB.cbf]

Delete exsiting files in the streamers basedir

DELETE basedir/files

204

Get free space (in bytes) of the the streamers basedir directory

GET basedir/space

200 - 1234556

Get accounting for last 10 streams (active streams are not included in the list)

GET accounting

200 - [ { "status": { "sendCount": 0 }, "configuration": { "source": [ { "searchPath": "", "searchPattern": "glob:*", "destinationPath": "", "numberOfImages": 0, "streamExistingFiles": false } ], "header": null, "port": 8888, "highWaterMark": 1000, "wipeFile": true, "method": "push/pull" }, "trackingId": "four" } ]

 * The first element holds the most recently closed stream, the last the most passed closed stream



### Command Line

Create stream

```bash
curl -XPUT --data '{"searchPath":"/Users/ebner/Desktop/Test", "searchPattern":"glob:*","destinationPath":"something"}' --header "Content-Type: application/json" http://<hostname>:<port>/stream/id

Stop stream

curl -XDELETE http://<hostname>:<port>/stream/id

Get stream status

curl http://<hostname>:<port>/stream/id

Get active streams (monitor)

curl -H "Accept: application/json" http://<hostname>:<port>/stream

Get active streams (monitor)

curl http://<hostname>:<port>/stream

Installation

The Stream package required Java 7 or greater.

Simple Installation

• Download the latest streamer from here
• Extract zip file

Daemon Installation

mkdir /opt/streamer
cd /opt/streamer
unzip ch.psi.zmq.streamer-<version>-bin.zip
ln -s ch.psi.zmq.streamer-<version> latest

Register Init Script

cp latest/var/streamer /etc/init.d/
chmod 755 /etc/init.d/streamer

Create RAMDISK

mkdir /tmp/ramdisk

! Make sure that the ramdisk is writable by the detector user !

On RHEL Linux

chkconfig --add streamer
chkconfig streamer on

On Ubuntu Linux

update-rc.d streamer defaults

Start/Stop Streamer Service

service streamer start
service streamer stop