SockJSSocket (vertx-web 3.3.1 API)

java.lang.Object
- io.vertx.rxjava.ext.web.handler.sockjs.SockJSSocket

All Implemented Interfaces:

io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>, io.vertx.rxjava.core.streams.StreamBase, io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
```
public class SockJSSocket
extends Object
implements io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>, io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
```
You interact with SockJS clients through instances of SockJS socket.
The API is very similar to WebSocket. It implements both and so it can be used with Pump to pump data with flow control.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Constructor Summary

Constructors
Constructor and Description

SockJSSocket(SockJSSocket delegate)

Constructors
Constructor and Description
`SockJSSocket(SockJSSocket delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close it
`SockJSSocket`	`drainHandler(Handler<Void> handler)`
`void`	`end()` Call `end(io.vertx.rxjava.core.buffer.Buffer)`.
`void`	`end(io.vertx.rxjava.core.buffer.Buffer t)`
`SockJSSocket`	`endHandler(Handler<Void> endHandler)`
`SockJSSocket`	`exceptionHandler(Handler<Throwable> handler)`
`Object`	`getDelegate()`
`SockJSSocket`	`handler(Handler<io.vertx.rxjava.core.buffer.Buffer> handler)`
`MultiMap`	`headers()` Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons
`io.vertx.rxjava.core.net.SocketAddress`	`localAddress()` Return the local address for this socket
`static SockJSSocket`	`newInstance(SockJSSocket arg)`
`SockJSSocket`	`pause()`
`io.vertx.rxjava.core.net.SocketAddress`	`remoteAddress()` Return the remote address for this socket
`SockJSSocket`	`resume()`
`SockJSSocket`	`setWriteQueueMaxSize(int maxSize)`
`rx.Observable<io.vertx.rxjava.core.buffer.Buffer>`	`toObservable()`
`String`	`uri()` Return the URI corresponding to the last request for this socket or the websocket handshake
`Session`	`webSession()`
`User`	`webUser()`
`SockJSSocket`	`write(io.vertx.rxjava.core.buffer.Buffer data)`
`String`	`writeHandlerID()` When a `SockJSSocket` is created it automatically registers an event handler with the event bus, the ID of that handler is given by `writeHandlerID`.
`boolean`	`writeQueueFull()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream
newInstance

Methods inherited from interface io.vertx.rxjava.core.streams.WriteStream
newInstance

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase
newInstance

- Constructor Detail
  - SockJSSocket
```
public SockJSSocket(SockJSSocket delegate)
```
- Method Detail
  - getDelegate
```
public Object getDelegate()
```
    Specified by:
    
    getDelegate in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
    
    Specified by:
    
    getDelegate in interface io.vertx.rxjava.core.streams.StreamBase
    
    Specified by:
    
    getDelegate in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - toObservable
```
public rx.Observable<io.vertx.rxjava.core.buffer.Buffer> toObservable()
```
    Specified by:
    
    toObservable in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
  - end
```
public void end(io.vertx.rxjava.core.buffer.Buffer t)
```
    Specified by:
    
    end in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - writeQueueFull
```
public boolean writeQueueFull()
```
    Specified by:
    
    writeQueueFull in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - exceptionHandler
```
public SockJSSocket exceptionHandler(Handler<Throwable> handler)
```
    Specified by:
    
    exceptionHandler in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
    
    Specified by:
    
    exceptionHandler in interface io.vertx.rxjava.core.streams.StreamBase
    
    Specified by:
    
    exceptionHandler in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - handler
```
public SockJSSocket handler(Handler<io.vertx.rxjava.core.buffer.Buffer> handler)
```
    Specified by:
    
    handler in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
  - pause
```
public SockJSSocket pause()
```
    Specified by:
    
    pause in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
  - resume
```
public SockJSSocket resume()
```
    Specified by:
    
    resume in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
  - endHandler
```
public SockJSSocket endHandler(Handler<Void> endHandler)
```
    Specified by:
    
    endHandler in interface io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.buffer.Buffer>
  - write
```
public SockJSSocket write(io.vertx.rxjava.core.buffer.Buffer data)
```
    Specified by:
    
    write in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - setWriteQueueMaxSize
```
public SockJSSocket setWriteQueueMaxSize(int maxSize)
```
    Specified by:
    
    setWriteQueueMaxSize in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - drainHandler
```
public SockJSSocket drainHandler(Handler<Void> handler)
```
    Specified by:
    
    drainHandler in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - writeHandlerID
```
public String writeHandlerID()
```
    When a SockJSSocket 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 socket. This allows you to write data to other sockets which are owned by different event loops.
    
    Returns:
  - end
```
public void end()
```
    Call end(io.vertx.rxjava.core.buffer.Buffer).
    
    Specified by:
    
    end in interface io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>
  - close
```
public void close()
```
    Close it
  - remoteAddress
```
public io.vertx.rxjava.core.net.SocketAddress remoteAddress()
```
    Return the remote address for this socket
    
    Returns:
  - localAddress
```
public io.vertx.rxjava.core.net.SocketAddress localAddress()
```
    Return the local address for this socket
    
    Returns:
  - headers
```
public MultiMap headers()
```
    Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons
    
    Returns:
  - uri
```
public String uri()
```
    Return the URI corresponding to the last request for this socket or the websocket handshake
    
    Returns:
  - webSession
```
public Session webSession()
```
    Returns:
    
    the Vert.x-Web session corresponding to this socket
  - webUser
```
public User webUser()
```
    Returns:
    
    the Vert.x-Web user corresponding to this socket
  - newInstance
```
public static SockJSSocket newInstance(SockJSSocket arg)
```

Class SockJSSocket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream

Methods inherited from interface io.vertx.rxjava.core.streams.WriteStream

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase

Constructor Detail

SockJSSocket

Method Detail

getDelegate

toObservable

end

writeQueueFull

exceptionHandler

handler

pause

resume

endHandler

write

setWriteQueueMaxSize

drainHandler

writeHandlerID

end

close

remoteAddress

localAddress

headers

uri

webSession

webUser

newInstance