com.oracle.libuv

Class PipeHandle

java.lang.Object

com.oracle.libuv.Handle

com.oracle.libuv.PipeHandle

All Implemented Interfaces:

Closeable, AutoCloseable

public class PipeHandle
extends Handle

Pipe handles provide an abstraction over streaming files on Unix (including local domain sockets, pipes, and FIFOs) and named pipes on Windows.

See Pipe handle

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected StreamCloseCallback	onClose
protected StreamConnectCallback	onConnect
protected StreamConnectionCallback	onConnection
protected StreamReadCallback	onRead
protected StreamShutdownCallback	onShutdown
protected StreamWriteCallback	onWrite
protected boolean	readStarted

Fields inherited from class com.oracle.libuv.Handle

loop, pointer

Method Summary

Modifier and Type	Method and Description
int	accept(com.oracle.libuv.StreamHandle client) Accepts connections.
int	bind(String name) Bind the pipe to a file path (Unix) or a name (Windows).
protected void	callClose()
protected void	callConnect(int status, Exception error, Object context)
protected void	callConnection(int status, Exception error)
protected void	callRead(ByteBuffer data)
protected void	callShutdown(int status, Exception error, Object context)
protected void	callWrite(int status, Exception error, Object context)
void	close()
int	closeWrite()
void	connect(String name)
boolean	isReadable()
boolean	isWritable()
int	listen(int backlog)
void	readStart()
void	readStop()
void	setCloseCallback(StreamCloseCallback callback)
void	setConnectCallback(StreamConnectCallback callback)
void	setConnectionCallback(StreamConnectionCallback callback)
void	setReadCallback(StreamReadCallback callback)
void	setShutdownCallback(StreamShutdownCallback callback)
void	setWriteCallback(StreamWriteCallback callback)
int	write(ByteBuffer buffer)
int	write(ByteBuffer buffer, int offset, int length)
int	write(String str)
int	write(String str, Charset encoding)
long	writeQueueSize()

Methods inherited from class com.oracle.libuv.Handle

equals, hashCode, isClosing, ref, toString, unref

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

closed

protected boolean closed

readStarted

protected boolean readStarted

onRead

protected StreamReadCallback onRead

onWrite

protected StreamWriteCallback onWrite

onConnect

protected StreamConnectCallback onConnect

onConnection

protected StreamConnectionCallback onConnection

onClose

protected StreamCloseCallback onClose

onShutdown

protected StreamShutdownCallback onShutdown

Method Detail

bind

public int bind(String name)

Bind the pipe to a file path (Unix) or a name (Windows).

Parameters:

name - socket, pipe or FIFO name.

Returns:

0 on success, or an error code < 0 on failure.

accept

public int accept(com.oracle.libuv.StreamHandle client)

Accepts connections.

This call is used in conjunction with listen(int) to accept incoming connections.

Call this function after receiving a StreamConnectionCallback to accept the connection. Before calling this function the client handle must be initialized.

Returns:

0 on success, or an error code < 0 on failure.

connect

public void connect(String name)

setReadCallback

public void setReadCallback(StreamReadCallback callback)

setWriteCallback

public void setWriteCallback(StreamWriteCallback callback)

setConnectCallback

public void setConnectCallback(StreamConnectCallback callback)

setConnectionCallback

public void setConnectionCallback(StreamConnectionCallback callback)

setCloseCallback

public void setCloseCallback(StreamCloseCallback callback)

setShutdownCallback

public void setShutdownCallback(StreamShutdownCallback callback)

readStart

public void readStart()

readStop

public void readStop()

write

public int write(String str)

write

public int write(String str,
                 Charset encoding)

write

public int write(ByteBuffer buffer,
                 int offset,
                 int length)

write

public int write(ByteBuffer buffer)

closeWrite

public int closeWrite()

close

public void close()

listen

public int listen(int backlog)

isReadable

public boolean isReadable()

isWritable

public boolean isWritable()

writeQueueSize

public long writeQueueSize()

callRead

protected void callRead(ByteBuffer data)

callWrite

protected void callWrite(int status,
                         Exception error,
                         Object context)

callConnect

protected void callConnect(int status,
                           Exception error,
                           Object context)

callConnection

protected void callConnection(int status,
                              Exception error)

callClose

protected void callClose()

callShutdown

protected void callShutdown(int status,
                            Exception error,
                            Object context)