com.microsoft.signalr.HubProtocol Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of signalr Show documentation

ASP.NET Core SignalR Client for Java applications

There is a newer version: 9.0.0-preview.7.24406.2

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

package com.microsoft.signalr;

import java.nio.ByteBuffer;
import java.util.List;

/**
 * A protocol abstraction for communicating with SignalR hubs.
 */
public interface HubProtocol {
    String getName();
    int getVersion();

    /**
     * Creates a new list of {@link HubMessage}s.
     * @param message A ByteBuffer representation of one or more {@link HubMessage}s.
     * @param binder The {@link InvocationBinder} to use for this Protocol instance.
     * @return A list of {@link HubMessage}s.
     */
    List parseMessages(ByteBuffer message, InvocationBinder binder);

    /**
     * Writes the specified {@link HubMessage} to a String.
     * @param message The message to write.
     * @return A ByteBuffer representation of the message.
     */
    ByteBuffer writeMessage(HubMessage message);
}