net.fortytwo.smsn.p2p.osc.slip

Class SlipOutputStream

java.lang.Object

net.fortytwo.smsn.p2p.osc.slip.SlipOutputStream

public class SlipOutputStream
extends Object

A utility for sending byte array packets via the Serial Line Internet Protocol (SLIP)

Constructor Summary

Constructors

Constructor and Description
SlipOutputStream(OutputStream outputStream) Constructs a new non-threaded SlipOutputStream
SlipOutputStream(OutputStream outputStream, boolean threaded) Constructs a new SlipOutputStream, optionally with an internal thread

Method Summary

Modifier and Type	Method and Description
void	close()
void	send(byte[] packet)
void	setThrottlingPeriod(long throttlingPeriod) Enforces a delay between the sending of consecutive packets, necessary for downstream applications which are sensitive to data rate

Methods inherited from class java.lang.Object

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

Constructor Detail

SlipOutputStream

public SlipOutputStream(OutputStream outputStream,
                        boolean threaded)

Constructs a new SlipOutputStream, optionally with an internal thread

Parameters:

outputStream - the lower-level stream to which to write packet data

threaded - if true, this stream will synchronize outbound serial communications using an internal thread

SlipOutputStream

public SlipOutputStream(OutputStream outputStream)

Constructs a new non-threaded SlipOutputStream

Parameters:

outputStream - the wrapped, transport-level stream

Method Detail

setThrottlingPeriod

public void setThrottlingPeriod(long throttlingPeriod)

Enforces a delay between the sending of consecutive packets, necessary for downstream applications which are sensitive to data rate

Parameters:

throttlingPeriod - the minimum time in milliseconds between the moment at which we begin to send one packet and the moment at which we begin to send the next Note: a throttling period is not necessary to ensure synchronous and sequential writing of packets to the output stream (for that, use the threaded option)

send

public void send(byte[] packet)
          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException