All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.ws.rs.sse.SseBroadcaster Maven / Gradle / Ivy

Go to download

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.10
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.ws.rs.sse;

import java.util.concurrent.CompletionStage;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

/**
 * Server-Sent events broadcasting facility.
 * 

* Server broadcaster can be used to manage multiple {@link SseEventSink server sinks}. It enables * sending events to all registered event outputs and provides facility to effectively handle * exceptions and closures of individual registered event outputs. *

* Instance of this interface is thread safe, meaning that it can be shared and its method invoked * from different threads without causing inconsistent internal state. * * @author Marek Potociar * @since 2.1 */ public interface SseBroadcaster extends AutoCloseable { /** * Register a listener, which will be called when an exception was thrown by a given SSE event output when trying * to write to it or close it. *

* This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. * The {@code SseBroadcaster} implementation is optimized to efficiently handle small amounts of * concurrent listener registrations and removals and large amounts of registered listener notifications. * * @param onError bi-consumer, taking two parameters: {@link SseEventSink}, which is the source of the * error and the actual {@link Throwable} instance. */ void onError(BiConsumer onError); /** * Register a listener, which will be called when the SSE event output has been closed (either by client closing * the connection or by calling {@link SseEventSink#close()} on the server side. *

* This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. * The {@code SseBroadcaster} implementation is optimized to efficiently handle small amounts of * concurrent listener registrations and removals and large amounts of registered listener notifications. * * @param onClose consumer taking single parameter, a {@link SseEventSink}, which was closed. */ void onClose(Consumer onClose); /** * Register provided {@link SseEventSink} instance to this {@code SseBroadcaster}. * * @param sseEventSink to be registered. */ void register(SseEventSink sseEventSink); /** * Publish an SSE event to all registered {@link SseEventSink} instances. * * @param event SSE event to be published. * @return completion stage that completes when the event has been broadcast to all registered event sinks. */ CompletionStage broadcast(final OutboundSseEvent event); /** * Close the broadcaster and all registered {@link SseEventSink} instances. *

* Any other resources associated with the {@link SseBroadcaster} should be released. *

* Subsequent calls have no effect and are ignored. Once the {@link SseBroadcaster} is closed, * invoking any other method on the broadcaster instance would result in an {@link IllegalStateException} * being thrown. */ @Override void close(); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy