com.hazelcast.internal.networking.OutboundFrame Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.internal.networking;
import com.hazelcast.client.impl.protocol.ClientMessage;
/**
* Represents a payload that can be written to a {@link Channel}.
*
* There is one type of OutboundFrame - {@link ClientMessage} for the new client to member communication.
*
* There is no need for an InboundFrame interface.
*
* Data
* {@link Channel#write(OutboundFrame)}
*/
public interface OutboundFrame {
/**
* Checks if this OutboundFrame is urgent.
*
* Frames that are urgent, have priority above regular frames. This is useful
* to implement system operations so that they can be sent faster than regular
* operations; especially when the system is under load you want these operations
* to have precedence.
*
* @return true if urgent, false otherwise.
*/
boolean isUrgent();
/**
* Returns the frame length. This includes header and payload size.
*
* @return The frame length.
*/
int getFrameLength();
}