Source: hyrrokkin_engine/client_interface.js

/*
    Hyrrokkin - a library for building and running executable graphs

    MIT License - Copyright (C) 2022-2025  Visual Topology Ltd

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software
    and associated documentation files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall 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.
*/

var hyrrokkin_engine = hyrrokkin_engine || {};

/**
 * a value that can be serialised to/from JSON
 *
 * @typedef {JSONSerialisable}
 */

/**
 * @callback ClientInterface~messageReceivedCallback
 *
 * @param @param {...(string|ArrayBuffer|JSONSerlialisable)} the message received, may be in multiple parts
 */

/**
 * Define an interface used by nodes to communicate with clients
 *
 * @interface
 *
 * @type {hyrrokkin_engine.ClientInterface}
 */
hyrrokkin_engine.ClientInterface = class {


    get_session_id() {
    }

    get_client_name() {
    }

    get_client_options() {
    }

    /**
     * set a function used to receive messages
     *
     * @param {ClientInterface~messageReceivedCallback} handler a function that will be called when a message from the client arrives
     */
    set_message_handler(handler) {
    }

    /**
     * send a message to the client
     *
     * @param {...*} message consists of zero or more components
     */
    send_message(...message) {
    }
}