class StompClient extends AnyRef
Defines a STOMP client.
- Alphabetic
- By Inheritance
- StompClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new StompClient(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: AnyRef
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): Unit
Closes the client.
-
def
connect(resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient
Connects to the server using the host and port configured in the client's options.
Connects to the server using the host and port configured in the client's options. * @param resultHandler handler called with the connection result. A failure will be sent to the handler if a TCP level issue happen before the
CONNECTED
frame is received. Afterwards, the #exceptionHandler(Handler) is called.- returns
the current StompClient
-
def
connect(port: Int, host: String, net: NetClient, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient
Connects to the server.
Connects to the server. * @param port the server port
- host
the server host
- net
the NET client to use
- resultHandler
handler called with the connection result
- returns
the current StompClient
-
def
connect(net: NetClient, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient
Connects to the server.
Connects to the server. * @param net the NET client to use
- resultHandler
handler called with the connection result
- returns
the current StompClient
-
def
connect(port: Int, host: String, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient
Connects to the server.
Connects to the server. * @param port the server port
- host
the server host
- resultHandler
handler called with the connection result
- returns
the current StompClient
-
def
connectFuture(): Future[StompClientConnection]
Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
connectFuture(port: Int, host: String, net: NetClient): Future[StompClientConnection]
Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
connectFuture(net: NetClient): Future[StompClientConnection]
Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
connectFuture(port: Int, host: String): Future[StompClientConnection]
Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
errorFrameHandler(handler: Handler[Frame]): StompClient
A general error frame handler.
A general error frame handler. It can be used to catch
ERROR
frame emitted during the connection process (wrong authentication). This error handler will be pass to all io.vertx.scala.ext.stomp.StompClientConnection created from this client. Obviously, the client can override it when the connection is established. * @param handler the handler- returns
the current StompClient
-
def
exceptionHandler(handler: Handler[Throwable]): StompClient
Sets an exception handler notified for TCP-level errors.
Sets an exception handler notified for TCP-level errors. * @param handler the handler
- returns
the current StompClient
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isClosed(): Boolean
- returns
whether or not the client is connected to the server.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
options(): StompClientOptions
- returns
the client's options.see StompClientOptions
-
def
receivedFrameHandler(handler: Handler[Frame]): StompClient
Configures a received handler that gets notified when a STOMP frame is received by the client.
Configures a received handler that gets notified when a STOMP frame is received by the client. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.
When a connection is created, the handler is used as io.vertx.scala.ext.stomp.StompClientConnection#receivedFrameHandler. * @param handler the handler
- returns
the current StompClient
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
vertx(): Vertx
- returns
the vert.x instance used by the client.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
writingFrameHandler(handler: Handler[Frame]): StompClient
Configures a writing handler that gets notified when a STOMP frame is written on the wire.
Configures a writing handler that gets notified when a STOMP frame is written on the wire. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.
When a connection is created, the handler is used as io.vertx.scala.ext.stomp.StompClientConnection#writingFrameHandler. * @param handler the handler
- returns
the current StompClient