org.glassfish.grizzly.websockets.Broadcaster Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013-2015 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
* https://glassfish.dev.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 org.glassfish.grizzly.websockets;
/**
* General Broadcaster API to send the same message to a set of clients.
*
* @author Alexey Stashok
*/
public interface Broadcaster {
/**
* Broadcasts the provided text content to the specified recipients.
*
* @param recipients the recipients of the provided text content.
* @param text textual content.
*/
void broadcast(final Iterable recipients,
final String text);
/**
* Broadcasts the provided binary content to the specified recipients.
*
* @param recipients the recipients of the provided binary content.
* @param binary binary content.
*/
void broadcast(final Iterable recipients,
final byte[] binary);
/**
* Broadcasts the provided fragmented text content to the specified recipients.
*
* @param recipients the recipients of the provided fragmented text content.
* @param text fragmented textual content.
* @param last true if this is the last fragment, otherwise false.
*/
void broadcastFragment(final Iterable recipients,
final String text, final boolean last);
/**
* Broadcasts the provided fragmented binary content to the specified recipients.
*
* @param recipients the recipients of the provided fragmented binary content.
* @param binary fragmented binary content.
* @param last true if this is the last fragment, otherwise false.
*/
void broadcastFragment(final Iterable recipients,
final byte[] binary, final boolean last);
}