io.vertx.groovy.ext.stomp.Acknowledgement.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-stomp Show documentation

Stomp support for Vert.x 3

There is a newer version: 5.0.0.CR5

/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.groovy.ext.stomp;
import groovy.transform.CompileStatic
import io.vertx.lang.groovy.InternalHelper
import io.vertx.core.json.JsonObject
import java.util.List
import io.vertx.ext.stomp.Frame
/**
 * Structure passed to acknowledgement handler called when a ACK or NACK frame is received. The handler
 * receives an instance of {@link io.vertx.groovy.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.
*/
@CompileStatic
public class Acknowledgement {
  private final def io.vertx.ext.stomp.Acknowledgement delegate;
  public Acknowledgement(Object delegate) {
    this.delegate = (io.vertx.ext.stomp.Acknowledgement) delegate;
  }
  public Object getDelegate() {
    return delegate;
  }
  /**
   * @return the subscription frame
   * @return  (see Frame)
   */
  public Map subscription() {
    def ret = (Map)InternalHelper.wrapObject(delegate.subscription()?.toJson());
    return ret;
  }
  /**
   * @return the list of frames that have been acknowledged / not-acknowledged. The content of the list depends on
   * the type of subscription.
   * @return 
   */
  public List> frames() {
    def ret = (List)delegate.frames()?.collect({(Map)InternalHelper.wrapObject(it?.toJson())});
    return ret;
  }
}