foreign/node/src/wire/message/flush-unsaved-buffers.command.ts

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.
//

import { type Id } from '../identifier.utils.js';
import { serializeFlushUnsavedBuffers } from './message.utils.js';
import { deserializeVoidResponse } from '../../client/client.utils.js';
import { wrapCommand } from '../command.utils.js';
import { COMMAND_CODE } from '../command.code.js';

/**
 * Parameters for the flush unsaved buffers command.
 */
export type FlushUnsavedBuffer = {
  /** Stream identifier */
  streamId: Id,
  /** Topic identifier */
  topicId: Id,
  /** Partition ID to flush */
  partitionId: number,
};

/**
 * Flush unsaved buffers command definition.
 * Forces buffered messages to be persisted to disk.
 */
export const FLUSH_UNSAVED_BUFFERS = {
  code: COMMAND_CODE.FlushUnsavedBuffers,

  serialize: ({ streamId, topicId, partitionId }: FlushUnsavedBuffer) => {
    return serializeFlushUnsavedBuffers(streamId, topicId, partitionId);
  },

  deserialize: deserializeVoidResponse
};

/**
 * Executable flush unsaved buffers command function.
 */
export const flushUnsavedBuffers = wrapCommand<FlushUnsavedBuffer, boolean>(FLUSH_UNSAVED_BUFFERS);