@mdf.js/openc2
Version:
MMS - API - Observability
32 lines • 1.44 kB
TypeScript
/**
* Copyright 2024 Mytra Control S.L. All rights reserved.
*
* Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
* or at https://opensource.org/licenses/MIT.
*/
import { Health, Layer } from '@mdf.js/core';
import { SocketIOClient } from '@mdf.js/socket-client-provider';
import { AdapterOptions, SocketIOClientOptions } from '../../types';
import { Adapter } from '../Adapter';
export declare abstract class SocketIOAdapter extends Adapter implements Layer.App.Resource {
/** Socket.IO provider instance */
protected readonly provider: SocketIOClient.Provider;
/**
* Create a new OpenC2 adapter for Socket.IO
* @param adapterOptions - Adapter configuration options
* @param type - component type
* @param options - Socket.IO client configuration options
*/
constructor(adapterOptions: AdapterOptions, type: 'producer' | 'consumer', options?: SocketIOClientOptions);
/** Adapter health status */
get status(): Health.Status;
/** Component checks */
get checks(): Health.Checks;
/** Connect the OpenC2 Adapter to the underlayer transport system */
start(): Promise<void>;
/** Connect the OpenC2 Adapter to the underlayer transport system */
stop(): Promise<void>;
/** Close the OpenC2 Adapter to the underlayer transport system */
close(): Promise<void>;
}
//# sourceMappingURL=SocketIOAdapter.d.ts.map