com.epam.deltix.qsrv.hf.pub.TimeMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of timebase-pub Show documentation
Timebase Public API Library
The newest version!
/*
 * Copyright 2023 EPAM Systems, Inc
 *
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. 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.epam.deltix.qsrv.hf.pub;

import com.epam.deltix.qsrv.hf.codec.MessageSizeCodec;
import com.epam.deltix.qsrv.hf.pub.codec.TimeCodec;
import com.epam.deltix.qsrv.hf.pub.md.BinaryDataType;
import com.epam.deltix.qsrv.hf.pub.md.NonStaticDataField;
import com.epam.deltix.qsrv.hf.pub.md.RecordClassDescriptor;
import com.epam.deltix.timebase.messages.service.SystemMessage;
import com.epam.deltix.util.collections.generated.ByteArrayList;

/**
 * @author Alexei Osipov
 */
public class TimeMessage extends SystemMessage {
    private static final String NAME = TimeMessage.class.getName();
    public static final String DESCRIPTOR_GUID = "SYS:TimeMessage:1";
    private static final int STUB_SIZE = 90; // bytes


    private ByteArrayList stubData;

    public static final RecordClassDescriptor DESCRIPTOR = new RecordClassDescriptor(
            DESCRIPTOR_GUID, NAME, NAME, false, null,
            new NonStaticDataField ("stubData", "Stub data to increase message size", BinaryDataType.getDefaultInstance())
    );

    public TimeMessage() {
        this.symbol = "";
        this.stubData = new ByteArrayList(STUB_SIZE);
        this.stubData.setSize(STUB_SIZE);
    }

    /**
     * @return estimated size of binary representation of {@link TimeMessage} when it serialized into Transient stream.
     * Note: Actual value may be smaller depending on time value.
     */
    public static int getTimeMessageSizeInTransientStream() {
        int messageBodySize = TimeCodec.TIME_SCALE_MILLISECONDS_FIELD_SIZE
                + STUB_SIZE + 5 // Stub
                + 1 // type
                + 2; // symbol
        return MessageSizeCodec.fieldSize(messageBodySize) + messageBodySize;
    }

    public ByteArrayList getStubData() {
        return stubData;
    }

    public void setStubData(ByteArrayList stubData) {
        this.stubData = stubData;
    }

    public boolean hasStubData() {
        return stubData != null;
    }

    public void nullifyStubData() {
        this.stubData = null;
    }
}