fucksocks.server.io

Class StreamPipe

java.lang.Object

fucksocks.server.io.StreamPipe

All Implemented Interfaces:

Pipe, Runnable

public class StreamPipe
extends Object
implements Runnable, Pipe

The class StreamPipe represents a pipe the can transfer data from a input stream to a output stream.

Version:

1.0

Author:

Youchao Feng

date

Apr 6, 2015 11:37:16 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger Logger that subclasses also can use.

Constructor Summary

Constructors

Constructor and Description
StreamPipe(InputStream from, OutputStream to) Constructs a Pipe instance with a input stream and a output stream.
StreamPipe(InputStream from, OutputStream to, String name) Constructs an instance of StreamPipe.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPipeListener(PipeListener pipeListener) Adds pipe listener.
boolean	close() Close pipe.
protected int	doTransfer(byte[] buffer) Transfer a buffer.
int	getBufferSize() GEts the buffer size.
String	getName() Returns name of StreamPipe.
List<PipeListener>	getPipeListeners() Returns all PipeListener.
boolean	isRunning() If the pipe is running.
void	removePipeListener(PipeListener pipeListener) Removes pipe listener.
void	run()
void	setBufferSize(int bufferSize) Sets buffer size.
void	setName(String name) Sets a name.
void	setPipeListeners(List<PipeListener> pipeListeners) Sets PipeListener.
boolean	start() Start the pipe, the pipe will work with a new thread.
boolean	stop() Stop the pipe, the pipe will stop transferring data.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Logger that subclasses also can use.

Constructor Detail

StreamPipe

public StreamPipe(InputStream from,
          OutputStream to)

Constructs a Pipe instance with a input stream and a output stream.

Parameters:

from - stream where it comes from.

to - stream where it will be transfered to.

StreamPipe

public StreamPipe(InputStream from,
          OutputStream to,
          String name)

Constructs an instance of StreamPipe.

Parameters:

from - stream where it comes from.

to - stream where it will be transfered to.

name - Name of StreamPipe.

Method Detail

start

public boolean start()

Description copied from interface: Pipe

Start the pipe, the pipe will work with a new thread.

Specified by:

start in interface Pipe

Returns:

TODO

stop

public boolean stop()

Description copied from interface: Pipe

Stop the pipe, the pipe will stop transferring data.

Specified by:

stop in interface Pipe

Returns:

TODO

run

public void run()

Specified by:

run in interface Runnable

doTransfer

protected int doTransfer(byte[] buffer)

Transfer a buffer.

Parameters:

buffer - Buffer that transfer once.

Returns:

number of byte that transfered.

close

public boolean close()

Description copied from interface: Pipe

Close pipe. if pipe is closed, it can't be started again.

Specified by:

close in interface Pipe

Returns:

true if it closed.

getBufferSize

public int getBufferSize()

Description copied from interface: Pipe

GEts the buffer size.

Specified by:

getBufferSize in interface Pipe

Returns:

Buffer size.

setBufferSize

public void setBufferSize(int bufferSize)

Description copied from interface: Pipe

Sets buffer size.

Specified by:

setBufferSize in interface Pipe

Parameters:

bufferSize - Buffer size.

isRunning

public boolean isRunning()

Description copied from interface: Pipe

If the pipe is running.

Specified by:

isRunning in interface Pipe

Returns:

true if the pipe is running.

addPipeListener

public void addPipeListener(PipeListener pipeListener)

Description copied from interface: Pipe

Adds pipe listener.

Specified by:

addPipeListener in interface Pipe

Parameters:

pipeListener - Pipe listener.

removePipeListener

public void removePipeListener(PipeListener pipeListener)

Description copied from interface: Pipe

Removes pipe listener.

Specified by:

removePipeListener in interface Pipe

Parameters:

pipeListener - Pipe listener.

getPipeListeners

public List<PipeListener> getPipeListeners()

Returns all PipeListener.

Returns:

All PipeListener.

setPipeListeners

public void setPipeListeners(List<PipeListener> pipeListeners)

Sets PipeListener.

Parameters:

pipeListeners - a List of PipeListener.

getName

public String getName()

Returns name of StreamPipe.

Specified by:

getName in interface Pipe

Returns:

Name of StreamPipe.

setName

public void setName(String name)

Sets a name.

Specified by:

setName in interface Pipe

Parameters:

name - Name of StreamPipe.