public class NetSocket extends Object implements ReadStream<Buffer>, WriteStream<Buffer>
Instances of this class are created on the client side by an NetClient
when a connection to a server is made, or on the server side by a NetServer
when a server accepts a connection.
It implements both and so it can be used with
Pump to pump data with flow control.
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the NetSocket
|
NetSocket |
closeHandler(Handler<Void> handler)
Set a handler that will be called when the NetSocket is closed
|
NetSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
NetSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
NetSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
Object |
getDelegate() |
NetSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
boolean |
isSsl() |
SocketAddress |
localAddress() |
static NetSocket |
newInstance(NetSocket arg) |
NetSocket |
pause()
Pause the
ReadSupport. |
SocketAddress |
remoteAddress() |
NetSocket |
resume()
Resume reading.
|
NetSocket |
sendFile(String filename)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
NetSocket |
sendFile(String filename,
Handler<AsyncResult<Void>> resultHandler)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
NetSocket |
sendFile(String filename,
long offset,
Handler<AsyncResult<Void>> resultHandler)
Same as
NetSocket but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
sendFile(String filename,
long offset,
long length)
Tell the operating system to stream a file as specified by
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. |
NetSocket |
sendFile(String filename,
long offset,
long length,
Handler<AsyncResult<Void>> resultHandler)
Same as
NetSocket but also takes a handler that will be called when the send has completed or
a failure has occurred |
rx.Observable<Void> |
sendFileObservable(String filename)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
rx.Observable<Void> |
sendFileObservable(String filename,
long offset)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
rx.Observable<Void> |
sendFileObservable(String filename,
long offset,
long length)
Same as
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurred |
NetSocket |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
rx.Observable<Buffer> |
toObservable() |
NetSocket |
upgradeToSsl(Handler<Void> handler)
Upgrade channel to use SSL/TLS.
|
NetSocket |
write(Buffer data)
Write some data to the stream.
|
NetSocket |
write(String str)
Write a
String to the connection, encoded in UTF-8. |
NetSocket |
write(String str,
String enc)
Write a
String to the connection, encoded using the encoding enc. |
String |
writeHandlerID()
When a
NetSocket is created it automatically registers an event handler with the event bus, the ID of that
handler is given by writeHandlerID. |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitnewInstancenewInstancenewInstancepublic NetSocket(NetSocket delegate)
public Object getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public rx.Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>public boolean writeQueueFull()
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)writeQueueFull in interface WriteStream<Buffer>public NetSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic NetSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public NetSocket pause()
ReadStreamReadSupport. While it's paused, no data will be sent to the dataHandlerpause in interface ReadStream<Buffer>public NetSocket resume()
ReadStreamReadSupport has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public NetSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>public NetSocket write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WriteStream<Buffer>data - the data to writepublic NetSocket setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize bytes in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic NetSocket drainHandler(Handler<Void> handler)
WriteStreamPump for an example of this being used.drainHandler in interface WriteStream<Buffer>handler - the handlerpublic String writeHandlerID()
NetSocket is created it automatically registers an event handler with the event bus, the ID of that
handler is given by writeHandlerID.
Given this ID, a different event loop can send a buffer to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other connections which are owned by different event loops.
public NetSocket write(String str)
String to the connection, encoded in UTF-8.str - the string to writepublic NetSocket write(String str, String enc)
String to the connection, encoded using the encoding enc.str - the string to writeenc - the encoding to usepublic NetSocket sendFile(String filename)
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.filename - file name of the file to sendpublic NetSocket sendFile(String filename, long offset)
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.filename - file name of the file to sendoffset - offsetpublic NetSocket sendFile(String filename, long offset, long length)
filename directly from disk to the outgoing connection,
bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.filename - file name of the file to sendoffset - offsetlength - lengthpublic NetSocket sendFile(String filename, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendresultHandler - handlerpublic rx.Observable<Void> sendFileObservable(String filename)
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendpublic NetSocket sendFile(String filename, long offset, Handler<AsyncResult<Void>> resultHandler)
NetSocket but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendoffset - offsetresultHandler - handlerpublic rx.Observable<Void> sendFileObservable(String filename, long offset)
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendoffset - offsetpublic NetSocket sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)
NetSocket but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendoffset - offsetlength - lengthresultHandler - handlerpublic rx.Observable<Void> sendFileObservable(String filename, long offset, long length)
sendFile(java.lang.String) but also takes a handler that will be called when the send has completed or
a failure has occurredfilename - file name of the file to sendoffset - offsetlength - lengthpublic SocketAddress remoteAddress()
public SocketAddress localAddress()
public void close()
public NetSocket closeHandler(Handler<Void> handler)
handler - the handlerpublic NetSocket upgradeToSsl(Handler<Void> handler)
handler - the handler will be notified when it's upgradedpublic boolean isSsl()
NetSocket is encrypted via SSL/TLS.Copyright © 2015. All rights reserved.