@hotmeshio/hotmesh/build/types/quorum.d.ts

Serverless Workflow

import { JobOutput } from './job';
import { StringAnyType } from './serializer';
interface CPULoad {
    [cpu: string]: string;
}
interface NetworkStat {
    iface: string;
    operstate: string;
    rx_bytes: number;
    rx_dropped: number;
    rx_errors: number;
    tx_bytes: number;
    tx_dropped: number;
    tx_errors: number;
    rx_sec: number;
    tx_sec: number;
    ms: number;
}
/** reveals: memory, cpu, network */
export interface SystemHealth {
    TotalMemoryGB: string;
    FreeMemoryGB: string;
    UsedMemoryGB: string;
    CPULoad: CPULoad[];
    NetworkStats: NetworkStat[];
}
export type ThrottleOptions = {
    /** target an engine OR worker by GUID */
    guid?: string;
    /** target a worker quorum */
    topic?: string;
    /** entity/noun */
    entity?: string;
    /** in milliseconds; set to -1 for indefinite throttle */
    throttle: number;
    /** namespace */
    namespace?: string;
};
export interface QuorumProfile {
    namespace: string;
    app_id: string;
    engine_id: string;
    entity?: string;
    worker_topic?: string;
    stream?: string;
    stream_depth?: number;
    counts?: Record<string, number>;
    inited?: string;
    timestamp?: string;
    throttle?: number;
    reclaimDelay?: number;
    reclaimCount?: number;
    system?: SystemHealth;
    signature?: string;
}
interface QuorumMessageBase {
    entity?: string;
    guid?: string;
    topic?: string;
    type?: string;
}
export interface PingMessage extends QuorumMessageBase {
    type: 'ping';
    originator: string;
    details?: boolean;
}
export interface WorkMessage extends QuorumMessageBase {
    type: 'work';
    originator: string;
}
export interface CronMessage extends QuorumMessageBase {
    type: 'cron';
    originator: string;
}
export interface PongMessage extends QuorumMessageBase {
    type: 'pong';
    guid: string;
    originator: string;
    entity?: string;
    profile?: QuorumProfile;
}
export interface ActivateMessage extends QuorumMessageBase {
    type: 'activate';
    cache_mode: 'nocache' | 'cache';
    until_version: string;
}
export interface UserMessage extends QuorumMessageBase {
    type: 'user';
    topic: string;
    message: StringAnyType;
}
export interface JobMessage extends QuorumMessageBase {
    type: 'job';
    entity?: string;
    topic: string;
    job: JobOutput;
}
export interface ThrottleMessage extends QuorumMessageBase {
    type: 'throttle';
    guid?: string;
    entity?: string;
    topic?: string;
    throttle: number;
}
export interface RollCallMessage extends QuorumMessageBase {
    type: 'rollcall';
    guid?: string;
    entity?: string;
    topic?: string | null;
    interval: number;
    max?: number;
    signature?: boolean;
}
export interface JobMessageCallback {
    (topic: string, message: JobOutput): void;
}
export interface SubscriptionCallback {
    (topic: string, message: Record<string, any>): void;
}
export interface QuorumMessageCallback {
    (topic: string, message: QuorumMessage): void;
}
export type RollCallOptions = {
    delay?: number;
    namespace?: string;
};
export type SubscriptionOptions = {
    namespace?: string;
};
/**
 * The types in this file are used to define those messages that are sent
 * to hotmesh client instances when a new version is about to be activated.
 * These messages serve to coordinate the cache invalidation and switch-over
 * to the new version without any downtime and a coordinating parent server.
 */
export type QuorumMessage = PingMessage | PongMessage | ActivateMessage | WorkMessage | JobMessage | ThrottleMessage | RollCallMessage | CronMessage | UserMessage;
export {};