vertx-lang-scala-docs_2.12 3.4.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package asyncsql
  Definition Classes
    ext
-  package auth
  Definition Classes
    ext
-  package bridge
  Definition Classes
    ext
-  package dropwizard
  Definition Classes
    ext
-  package hawkular
  Definition Classes
    ext
-  package jdbc
  Definition Classes
    ext
-  package mail
  Definition Classes
    ext
-  package mongo
  Definition Classes
    ext
-  package shell
  Definition Classes
    ext
-  package sql
  Definition Classes
    ext
-  package stomp
  Definition Classes
    ext
- Acknowledgement
- BridgeOptions
- Destination
- DestinationFactory
- Frame
- Frames
- ServerFrame
- StompClient
- StompClientConnection
- StompClientOptions
- StompServer
- StompServerConnection
- StompServerHandler
- StompServerOptions
-  package web
  Definition Classes
    ext

p

io.vertx.scala.ext

# stomp 

#### package stomp

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  class Acknowledgement extends AnyRef

   Structure passed to acknowledgement handler called when a `ACK` or `NACK` frame is received.

   Structure passed to acknowledgement handler called when a `ACK` or `NACK` frame is received. The handler receives an instance of io.vertx.scala.ext.stomp.Acknowledgement with the subscription Frame and the impacted messages. The list of messages depends on the type of acknowledgment used by the subscription.

   Subscriptions using the `client` mode receives all messages that were waiting for acknowledgment that were sent before the acknowledged messages. The list also contains the acknowledged message. This is a cumulative acknowledgement. Subscriptions using the `client-individual` mode receives a singleton list containing only the acknowledged message.

2.  class BridgeOptions extends bridge.BridgeOptions

   Specify the event bus bridge options.

3.  class Destination extends AnyRef

   Represents a STOMP destination.

   Represents a STOMP destination. Depending on the implementation, the message delivery is different. Queue are sending message to only one subscribers, while topics are broadcasting the message to all subscribers.

   Implementations must be thread-safe.

4.  class DestinationFactory extends AnyRef

   Interface implemented to customize the destination creation.

5.  class Frame extends AnyRef

   Represents a STOMP frame.

   Represents a STOMP frame. STOMP frames are structured as follows. It starts by a `command`, followed by a set of headers. Then the frame may have a body and is finished by a `0` byte. This class represents this structure and provide access to the different parts.

   This class is NOT thread-safe.

6.  class Frames extends AnyRef

   Utility methods to build common Frames.

   Utility methods to build common Frames. It defines a non-STOMP frame (`PING`) that is used for heartbeats. When such frame is written on the wire it is just the `0` byte.

   This class is thread-safe.

7.  class ServerFrame extends AnyRef

   Structure passed to server handler when receiving a frame.

   Structure passed to server handler when receiving a frame. It provides a reference on the received Frame but also on the io.vertx.scala.ext.stomp.StompServerConnection.

8.  class StompClient extends AnyRef

   Defines a STOMP client.

9.  class StompClientConnection extends AnyRef

   Once a connection to the STOMP server has been made, client receives a io.vertx.scala.ext.stomp.StompClientConnection, that let send and receive STOMP frames.

10.  class StompClientOptions extends NetClientOptions

    Options used to configure a STOMP client.

    Options used to configure a STOMP client. As a STOMP client wraps a Net client, you can also configure the underlying NET client.

11.  class StompServer extends AnyRef

    Defines a STOMP server.

    Defines a STOMP server. STOMP servers delegates to a io.vertx.scala.ext.stomp.StompServerHandler that let customize the behavior of the server. By default, it uses a handler compliant with the STOMP specification, but let you change anything.

12.  class StompServerConnection extends AnyRef

    Class representing a connection between a STOMP client a the server.

    Class representing a connection between a STOMP client a the server. It keeps a references on the client socket, so let write to this socket.

13.  class StompServerHandler extends Handler[ServerFrame]

    STOMP server handler implements the behavior of the STOMP server when a specific event occurs.

    STOMP server handler implements the behavior of the STOMP server when a specific event occurs. For instance, if let customize the behavior when specific STOMP frames arrives or when a connection is closed. This class has been designed to let you customize the server behavior. The default implementation is compliant with the STOMP specification. In this default implementation, not acknowledge frames are dropped.

14.  class StompServerOptions extends NetServerOptions

    STOMP Server options.

    STOMP Server options. You can also configure the Net Server used by the STOMP server from these options.

### Value Members

1.  object Acknowledgement
2.  object BridgeOptions
3.  object Destination
4.  object DestinationFactory
5.  object Frame
6.  object Frames
7.  object ServerFrame
8.  object StompClient
9.  object StompClientConnection
10.  object StompClientOptions
11.  object StompServer
12.  object StompServerConnection
13.  object StompServerHandler
14.  object StompServerOptions

### Ungrouped