org.atmosphere.annotation.Resume Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atmosphere-annotations Show documentation

There is a newer version: 2.7.15

Show newest version

/*
 * Copyright 2008-2024 Async-IO.org
 *
 * Licensed 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 org.atmosphere.annotation;


import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Resume a suspended response. A suspended response is the result of annotating any method
 * using the {@link Suspend}.
 *
 * @author Jeanfrancois Arcand
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Resume {

    /**
     * Resume after the first event caused by annotating a method with {@link Broadcast}
     *
     * @return
     */
    int value() default 1; // long polling
}