io.apigee.trireme.net.spi

Interface UpgradedSocket

public interface UpgradedSocket

This interface must be implemented by servers that wish to support the "upgrade" option to HTTP. It lets them directly send and receive bytes over their own network connection in a way that will allow them to be plugged in to Node.js.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the socket.
void	shutdownOutput(IOCompletionHandler<Integer> handler) Send a "shutdown" to shutdown output onthe socket without closing it.
void	startReading(IOCompletionHandler<ByteBuffer> handler) Start reading by delivering data to the handler.
void	stopReading() Stop reading data from the socket for flow-control purposes.
int	write(ByteBuffer buf, IOCompletionHandler<Integer> handler) Called to write data back to the socket.

Method Detail

write

int write(ByteBuffer buf,
        IOCompletionHandler<Integer> handler)

Called to write data back to the socket. Return the number of bytes written. It is also necessary to call "onComplete" on the handler to indicate when the write completes -- if writes happen synchronously, then call this right away.

startReading

void startReading(IOCompletionHandler<ByteBuffer> handler)

Start reading by delivering data to the handler.

stopReading

void stopReading()

Stop reading data from the socket for flow-control purposes.

close

void close()

Close the socket.

shutdownOutput

void shutdownOutput(IOCompletionHandler<Integer> handler)

Send a "shutdown" to shutdown output onthe socket without closing it.