fucksocks.server.io

Interface Pipe

All Known Implementing Classes:

SocketPipe, StreamPipe

public interface Pipe

The class Pipe represents a pipe that can transfer byte.

Version:

1.0

Author:

Youchao Feng

date

Apr 15, 2015 9:31:29 AM

Method Summary

Methods

Modifier and Type	Method and Description
void	addPipeListener(PipeListener pipeListener) Adds pipe listener.
boolean	close() Close pipe.
int	getBufferSize() GEts the buffer size.
String	getName() Returns pipe's name.
boolean	isRunning() If the pipe is running.
void	removePipeListener(PipeListener pipeListener) Removes pipe listener.
void	setBufferSize(int bufferSize) Sets buffer size.
void	setName(String name) Sets pipe's name.
boolean	start() Start the pipe, the pipe will work with a new thread.
boolean	stop() Stop the pipe, the pipe will stop transferring data.

Method Detail

start

boolean start()

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

Returns:

TODO

stop

boolean stop()

Stop the pipe, the pipe will stop transferring data.

Returns:

TODO

close

boolean close()

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

Returns:

true if it closed.

getBufferSize

int getBufferSize()

GEts the buffer size.

Returns:

Buffer size.

setBufferSize

void setBufferSize(int bufferSize)

Sets buffer size.

Parameters:

bufferSize - Buffer size.

isRunning

boolean isRunning()

If the pipe is running.

Returns:

true if the pipe is running.

addPipeListener

void addPipeListener(PipeListener pipeListener)

Adds pipe listener.

Parameters:

pipeListener - Pipe listener.

removePipeListener

void removePipeListener(PipeListener pipeListener)

Removes pipe listener.

Parameters:

pipeListener - Pipe listener.

setName

void setName(String name)

Sets pipe's name.

Parameters:

name - Name of pipe.

getName

String getName()

Returns pipe's name.

Returns:

Name of pipe.