com.hazelcast.nio.OutboundFrame Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2017, 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.nio;
import com.hazelcast.spi.annotation.PrivateApi;
/**
* Represents something that can be written to a {@link com.hazelcast.nio.Connection}.
*
* There are different types of OutboundFrame:
*
* - Packet: for member to member and old-client to member communication
* - TextMessage: for memcached and rest communication
* - ClientMessage: for the new client to member communication
*
*
* Till so far, all communication over a single connection, will be of a single Frame-class. E.g. member
* to member only uses Packets.
*
* There is no need for an InboundFrame interface.
*
* @see com.hazelcast.nio.serialization.Data
* @see Connection#write(OutboundFrame)
*/
@PrivateApi
public interface OutboundFrame {
/**
* Checks if this Frame is urgent.
*
* Frames that are urgent, have priority above regular frames. This is useful to implement
* System Operations so that they can be send faster than regular operations; especially when the system is
* under load you want these operations have precedence.
*
* @return true if urgent, false otherwise.
*/
boolean isUrgent();
}