services.moleculer.stream

Class PacketStream

java.lang.Object

services.moleculer.stream.PacketStream

public class PacketStream
extends java.lang.Object

NodeJS compatible streaming API to transfer binary files/content.

Sample service invocation with a stream:

 PacketStream stream = broker.createStream();
 broker.call("streamService.action", stream);
 stream.sendData("body".getBytes());
 stream.sendClose(); // Must close!
 

Sample stream receiver service:

 public class StreamService extends Service {
        public Action action = ctx -> {
                return new Promise(res -> {
                        ctx.stream.onPacket((bytes, cause, close) -> {
                                if (bytes != null) {
                                        // Do something with the bytes
                                }
                                if (close) {
                                        // Send response, can be a structure (Tree)
                                        res.resolve("Ok");
                                }
                        });
                });
        };
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedList<byte[]>	buffer Memory-buffer of an unconnected stream.
protected java.lang.Throwable	cause Cause (blocking error).
protected static byte[]	CLOSE_MARKER
protected java.util.concurrent.atomic.AtomicBoolean	closed Is stream closed?
protected static int	DEFAULT_MIN_PACKET_SIZE
protected PacketListener[]	listeners Array of PacketListeners (receivers).
protected static org.slf4j.Logger	logger
protected java.lang.String	nodeID Current node ID.
protected long	packetDelay Time between each packet sent.
protected int	packetSize Minimum size of packets.
protected java.util.concurrent.ScheduledExecutorService	scheduler
protected java.util.concurrent.atomic.AtomicLong	transferedBytes Counter of transfered bytes.

Constructor Summary

Constructors

Constructor and Description
PacketStream(java.lang.String nodeID, java.util.concurrent.ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	asOutputStream()
java.nio.channels.WritableByteChannel	asWritableByteChannel()
java.lang.Throwable	getCause()
long	getPacketDelay()
int	getPacketSize()
long	getTransferedBytes()
boolean	isClosed()
boolean	onPacket(PacketListener listener)
protected void	scheduleNextPacket(java.io.InputStream source, java.io.OutputStream destination, io.datatree.Promise promise, byte[] packet)
protected void	scheduleNextPacket(java.nio.channels.ReadableByteChannel source, java.io.OutputStream destination, io.datatree.Promise promise, java.nio.ByteBuffer packet)
boolean	sendClose()
boolean	sendData(byte[] bytes)
boolean	sendError(java.lang.Throwable cause)
void	setPacketDelay(long packetDelay)
void	setPacketSize(int packetSize)
io.datatree.Promise	transferFrom(java.io.File source)
io.datatree.Promise	transferFrom(java.io.InputStream source)
io.datatree.Promise	transferFrom(java.nio.channels.ReadableByteChannel source)
io.datatree.Promise	transferFrom(java.net.URL source)
io.datatree.Promise	transferTo(java.io.File destination)
io.datatree.Promise	transferTo(java.io.File destination, boolean append)
io.datatree.Promise	transferTo(java.io.OutputStream destination)
io.datatree.Promise	transferTo(java.io.OutputStream destination, boolean closeStream)
io.datatree.Promise	transferTo(java.nio.channels.WritableByteChannel destination)
io.datatree.Promise	transferTo(java.nio.channels.WritableByteChannel destination, boolean closeChannel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MIN_PACKET_SIZE

protected static final int DEFAULT_MIN_PACKET_SIZE

See Also:

Constant Field Values

CLOSE_MARKER

protected static final byte[] CLOSE_MARKER

logger

protected static final org.slf4j.Logger logger

scheduler

protected final java.util.concurrent.ScheduledExecutorService scheduler

nodeID

protected final java.lang.String nodeID

Current node ID.

closed

protected final java.util.concurrent.atomic.AtomicBoolean closed

Is stream closed?

See Also:

isClosed

buffer

protected final java.util.LinkedList<byte[]> buffer

Memory-buffer of an unconnected stream. Connected streams do not use this buffer.

transferedBytes

protected final java.util.concurrent.atomic.AtomicLong transferedBytes

Counter of transfered bytes.

See Also:

getTransferedBytes

listeners

protected PacketListener[] listeners

Array of PacketListeners (receivers).

cause

protected java.lang.Throwable cause

Cause (blocking error).

packetSize

protected int packetSize

Minimum size of packets.

packetDelay

protected long packetDelay

Time between each packet sent. This may be necessary because the other Threads will get some CPU-time.

Constructor Detail

PacketStream

public PacketStream(java.lang.String nodeID,
                    java.util.concurrent.ScheduledExecutorService scheduler)

Method Detail

onPacket

public boolean onPacket(PacketListener listener)

sendData

public boolean sendData(byte[] bytes)

sendError

public boolean sendError(java.lang.Throwable cause)

sendClose

public boolean sendClose()

asOutputStream

public java.io.OutputStream asOutputStream()

asWritableByteChannel

public java.nio.channels.WritableByteChannel asWritableByteChannel()

transferFrom

public io.datatree.Promise transferFrom(java.net.URL source)

transferFrom

public io.datatree.Promise transferFrom(java.io.File source)

transferFrom

public io.datatree.Promise transferFrom(java.io.InputStream source)

transferFrom

public io.datatree.Promise transferFrom(java.nio.channels.ReadableByteChannel source)

scheduleNextPacket

protected void scheduleNextPacket(java.nio.channels.ReadableByteChannel source,
                                  java.io.OutputStream destination,
                                  io.datatree.Promise promise,
                                  java.nio.ByteBuffer packet)

scheduleNextPacket

protected void scheduleNextPacket(java.io.InputStream source,
                                  java.io.OutputStream destination,
                                  io.datatree.Promise promise,
                                  byte[] packet)

transferTo

public io.datatree.Promise transferTo(java.io.File destination)

transferTo

public io.datatree.Promise transferTo(java.io.File destination,
                                      boolean append)

transferTo

public io.datatree.Promise transferTo(java.io.OutputStream destination)

transferTo

public io.datatree.Promise transferTo(java.io.OutputStream destination,
                                      boolean closeStream)

transferTo

public io.datatree.Promise transferTo(java.nio.channels.WritableByteChannel destination)

transferTo

public io.datatree.Promise transferTo(java.nio.channels.WritableByteChannel destination,
                                      boolean closeChannel)

getPacketSize

public int getPacketSize()

setPacketSize

public void setPacketSize(int packetSize)

getPacketDelay

public long getPacketDelay()

setPacketDelay

public void setPacketDelay(long packetDelay)

isClosed

public boolean isClosed()

getTransferedBytes

public long getTransferedBytes()

getCause

public java.lang.Throwable getCause()