@citrineos/base/dist/interfaces/messages/MessageSender.d.ts

The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.

import { IMessage, IMessageConfirmation, OcppError, OcppRequest, OcppResponse } from '../..';
import { MessageState } from '.';
/**
 * IMessageSender
 *
 * Represents an interface for sending messages.
 *
 * All implementations of this interface should carry any context from the {@link IMessage}
 * to be sent as metadata in the underlying message transport. This will allow to route
 * messages to the correct module and filter them accordingly.
 */
export interface IMessageSender {
    /**
     * Sends a request message.
     *
     * @param message - The message object.
     * @param payload - The payload object.
     * @returns A promise that resolves to the message confirmation.
     */
    sendRequest(message: IMessage<OcppRequest>, payload?: OcppRequest): Promise<IMessageConfirmation>;
    /**
     * Sends a response message.
     *
     * @param message - The message object.
     * @param payload - The payload object.
     * @returns A promise that resolves to the message confirmation.
     */
    sendResponse(message: IMessage<OcppResponse | OcppError>, payload?: OcppResponse | OcppError): Promise<IMessageConfirmation>;
    /**
     * Sends a message.
     *
     * @param message - The message object.
     * @param payload - The payload object.
     * @param state - The message state.
     * @returns A promise that resolves to the message confirmation.
     */
    send(message: IMessage<OcppRequest | OcppResponse | OcppError>, payload?: OcppRequest | OcppResponse | OcppError, state?: MessageState): Promise<IMessageConfirmation>;
    /**
     * Shuts down the sender.
     */
    shutdown(): Promise<void>;
}