/*
 * Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.graalvm.polyglot.io;

import java.io.IOException;
import java.nio.ByteBuffer;

An endpoint representing one side of message transport. The methods throw IOException when an I/O issue occurs or when the endpoint is closed. 
See Also:
MessageTransport
Since:
19.0/**
 * An endpoint representing one side of {@link MessageTransport message transport}. The methods
 * throw {@link IOException} when an I/O issue occurs or when the endpoint is closed.
 *
 * @see MessageTransport
 * @since 19.0
 */
public interface MessageEndpoint {

    
Send a text message.
Since:
19.0/**
     * Send a text message.
     *
     * @since 19.0
     */
    void sendText(String text) throws IOException;

    
Send a binary message.
Since:
19.0/**
     * Send a binary message.
     *
     * @since 19.0
     */
    void sendBinary(ByteBuffer data) throws IOException;

    
Send a ping request.
Since:
19.0/**
     * Send a ping request.
     *
     * @since 19.0
     */
    void sendPing(ByteBuffer data) throws IOException;

    
Send a pong reply as a response to ping.
Since:
19.0/**
     * Send a pong reply as a response to ping.
     *
     * @since 19.0
     */
    void sendPong(ByteBuffer data) throws IOException;

    
Close the connection.
Since:
19.0/**
     * Close the connection.
     *
     * @since 19.0
     */
    void sendClose() throws IOException;

}