com.hazelcast.client.impl.protocol.codec.MapSetTtlCodec 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.client.impl.protocol.codec;
import com.hazelcast.client.impl.protocol.ClientMessage;
import com.hazelcast.client.impl.protocol.Generated;
import com.hazelcast.client.impl.protocol.codec.builtin.DataCodec;
import com.hazelcast.client.impl.protocol.codec.builtin.StringCodec;
import static com.hazelcast.client.impl.protocol.ClientMessage.ForwardFrameIterator;
import static com.hazelcast.client.impl.protocol.ClientMessage.Frame;
import static com.hazelcast.client.impl.protocol.ClientMessage.PARTITION_ID_FIELD_OFFSET;
import static com.hazelcast.client.impl.protocol.ClientMessage.RESPONSE_BACKUP_ACKS_FIELD_OFFSET;
import static com.hazelcast.client.impl.protocol.ClientMessage.TYPE_FIELD_OFFSET;
import static com.hazelcast.client.impl.protocol.ClientMessage.UNFRAGMENTED_MESSAGE;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.BOOLEAN_SIZE_IN_BYTES;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.BYTE_SIZE_IN_BYTES;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.INT_SIZE_IN_BYTES;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.LONG_SIZE_IN_BYTES;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.decodeBoolean;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.decodeLong;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.encodeBoolean;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.encodeInt;
import static com.hazelcast.client.impl.protocol.codec.builtin.FixedSizeTypesCodec.encodeLong;
/*
* This file is auto-generated by the Hazelcast Client Protocol Code Generator.
* To change this file, edit the templates or the protocol
* definitions on the https://github.com/hazelcast/hazelcast-client-protocol
* and regenerate it.
*/
/**
* Updates TTL (time to live) value of the entry specified by {@code key} with a new TTL value.
* New TTL value is valid from this operation is invoked, not from the original creation of the entry.
* If the entry does not exist or already expired, then this call has no effect.
*
* The entry will expire and get evicted after the TTL. If the TTL is 0,
* then the entry lives forever. If the TTL is negative, then the TTL
* from the map configuration will be used (default: forever).
*
* If there is no entry with key {@code key}, this call has no effect.
*
* Warning:
*
* Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
*/
@SuppressWarnings("unused")
@Generated("4bb6242c9e864ded64549529cf697fdf")
public final class MapSetTtlCodec {
//hex: 0x014300
public static final int REQUEST_MESSAGE_TYPE = 82688;
//hex: 0x014301
public static final int RESPONSE_MESSAGE_TYPE = 82689;
private static final int REQUEST_TTL_FIELD_OFFSET = PARTITION_ID_FIELD_OFFSET + INT_SIZE_IN_BYTES;
private static final int REQUEST_INITIAL_FRAME_SIZE = REQUEST_TTL_FIELD_OFFSET + LONG_SIZE_IN_BYTES;
private static final int RESPONSE_RESPONSE_FIELD_OFFSET = RESPONSE_BACKUP_ACKS_FIELD_OFFSET + BYTE_SIZE_IN_BYTES;
private static final int RESPONSE_INITIAL_FRAME_SIZE = RESPONSE_RESPONSE_FIELD_OFFSET + BOOLEAN_SIZE_IN_BYTES;
private MapSetTtlCodec() {
}
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings({"URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"})
public static class RequestParameters {
/**
* Name of the map
*/
public String name;
/**
* Key for the map entry
*/
public com.hazelcast.internal.serialization.Data key;
/**
* The duration in milliseconds after which this entry shall be deleted. O means infinite.
*/
public long ttl;
}
public static ClientMessage encodeRequest(String name, com.hazelcast.internal.serialization.Data key, long ttl) {
ClientMessage clientMessage = ClientMessage.createForEncode();
clientMessage.setContainsSerializedDataInRequest(true);
clientMessage.setRetryable(false);
clientMessage.setOperationName("Map.SetTtl");
Frame initialFrame = new Frame(new byte[REQUEST_INITIAL_FRAME_SIZE], UNFRAGMENTED_MESSAGE);
encodeInt(initialFrame.content, TYPE_FIELD_OFFSET, REQUEST_MESSAGE_TYPE);
encodeInt(initialFrame.content, PARTITION_ID_FIELD_OFFSET, -1);
encodeLong(initialFrame.content, REQUEST_TTL_FIELD_OFFSET, ttl);
clientMessage.add(initialFrame);
StringCodec.encode(clientMessage, name);
DataCodec.encode(clientMessage, key);
return clientMessage;
}
public static RequestParameters decodeRequest(ClientMessage clientMessage) {
ForwardFrameIterator iterator = clientMessage.frameIterator();
RequestParameters request = new RequestParameters();
Frame initialFrame = iterator.next();
request.ttl = decodeLong(initialFrame.content, REQUEST_TTL_FIELD_OFFSET);
request.name = StringCodec.decode(iterator);
request.key = DataCodec.decode(iterator);
return request;
}
public static ClientMessage encodeResponse(boolean response) {
ClientMessage clientMessage = ClientMessage.createForEncode();
Frame initialFrame = new Frame(new byte[RESPONSE_INITIAL_FRAME_SIZE], UNFRAGMENTED_MESSAGE);
encodeInt(initialFrame.content, TYPE_FIELD_OFFSET, RESPONSE_MESSAGE_TYPE);
encodeBoolean(initialFrame.content, RESPONSE_RESPONSE_FIELD_OFFSET, response);
clientMessage.add(initialFrame);
return clientMessage;
}
/**
* 'true' if the entry is affected, 'false' otherwise
*/
public static boolean decodeResponse(ClientMessage clientMessage) {
ForwardFrameIterator iterator = clientMessage.frameIterator();
Frame initialFrame = iterator.next();
return decodeBoolean(initialFrame.content, RESPONSE_RESPONSE_FIELD_OFFSET);
}
}