@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
155 lines (154 loc) • 9.64 kB
TypeScript
import { type CallOptions, ChannelCredentials, Client, type ClientOptions, type ClientReadableStream, type ClientUnaryCall, type handleServerStreamingCall, type handleUnaryCall, Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
import { ApiPreferences } from "./common_params";
import { DeviceEventArgs, GetCanChannelBusSpeedsRequest, GetCanChannelBusSpeedsResponse, GetCanFdBusSpeedsRequest, GetCanFdBusSpeedsResponse, GetClassicCanBusSpeedsRequest, GetClassicCanBusSpeedsResponse, GetDevicesRequest, GetDevicesResponse } from "./device_params";
/** The device service. This service is responsible for keeping track of all available devices. */
export type DeviceServiceService = typeof DeviceServiceService;
export declare const DeviceServiceService: {
/**
* Starts a subscription for device events.
* @param request A request message with API preferences.
* @returns A stream of DeviceEventArgs messages.
*/
readonly subscribeForEvents: {
readonly path: "/deviceservice.DeviceService/SubscribeForEvents";
readonly requestStream: false;
readonly responseStream: true;
readonly requestSerialize: (value: ApiPreferences) => Buffer;
readonly requestDeserialize: (value: Buffer) => ApiPreferences;
readonly responseSerialize: (value: DeviceEventArgs) => Buffer;
readonly responseDeserialize: (value: Buffer) => DeviceEventArgs;
};
/**
* Gets all available devices.
* @param request A request message with API preferences.
* @returns A response message with all available devices.
*/
readonly getDevices: {
readonly path: "/deviceservice.DeviceService/GetDevices";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetDevicesRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetDevicesRequest;
readonly responseSerialize: (value: GetDevicesResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetDevicesResponse;
};
/**
* Gets the possible CAN channel bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN channel bus speeds.
*/
readonly getCanChannelBusSpeeds: {
readonly path: "/deviceservice.DeviceService/GetCanChannelBusSpeeds";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetCanChannelBusSpeedsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetCanChannelBusSpeedsRequest;
readonly responseSerialize: (value: GetCanChannelBusSpeedsResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetCanChannelBusSpeedsResponse;
};
/**
* Gets the possible classic CAN bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible classic CAN bus speeds.
*/
readonly getClassicCanBusSpeeds: {
readonly path: "/deviceservice.DeviceService/GetClassicCanBusSpeeds";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetClassicCanBusSpeedsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetClassicCanBusSpeedsRequest;
readonly responseSerialize: (value: GetClassicCanBusSpeedsResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetClassicCanBusSpeedsResponse;
};
/**
* Gets the possible CAN-FD bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN-FD bus speeds.
*/
readonly getCanFdBusSpeeds: {
readonly path: "/deviceservice.DeviceService/GetCanFdBusSpeeds";
readonly requestStream: false;
readonly responseStream: true;
readonly requestSerialize: (value: GetCanFdBusSpeedsRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetCanFdBusSpeedsRequest;
readonly responseSerialize: (value: GetCanFdBusSpeedsResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => GetCanFdBusSpeedsResponse;
};
};
export interface DeviceServiceServer extends UntypedServiceImplementation {
/**
* Starts a subscription for device events.
* @param request A request message with API preferences.
* @returns A stream of DeviceEventArgs messages.
*/
subscribeForEvents: handleServerStreamingCall<ApiPreferences, DeviceEventArgs>;
/**
* Gets all available devices.
* @param request A request message with API preferences.
* @returns A response message with all available devices.
*/
getDevices: handleUnaryCall<GetDevicesRequest, GetDevicesResponse>;
/**
* Gets the possible CAN channel bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN channel bus speeds.
*/
getCanChannelBusSpeeds: handleUnaryCall<GetCanChannelBusSpeedsRequest, GetCanChannelBusSpeedsResponse>;
/**
* Gets the possible classic CAN bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible classic CAN bus speeds.
*/
getClassicCanBusSpeeds: handleUnaryCall<GetClassicCanBusSpeedsRequest, GetClassicCanBusSpeedsResponse>;
/**
* Gets the possible CAN-FD bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN-FD bus speeds.
*/
getCanFdBusSpeeds: handleServerStreamingCall<GetCanFdBusSpeedsRequest, GetCanFdBusSpeedsResponse>;
}
export interface DeviceServiceClient extends Client {
/**
* Starts a subscription for device events.
* @param request A request message with API preferences.
* @returns A stream of DeviceEventArgs messages.
*/
subscribeForEvents(request: ApiPreferences, options?: Partial<CallOptions>): ClientReadableStream<DeviceEventArgs>;
subscribeForEvents(request: ApiPreferences, metadata?: Metadata, options?: Partial<CallOptions>): ClientReadableStream<DeviceEventArgs>;
/**
* Gets all available devices.
* @param request A request message with API preferences.
* @returns A response message with all available devices.
*/
getDevices(request: GetDevicesRequest, callback: (error: ServiceError | null, response: GetDevicesResponse) => void): ClientUnaryCall;
getDevices(request: GetDevicesRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetDevicesResponse) => void): ClientUnaryCall;
getDevices(request: GetDevicesRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetDevicesResponse) => void): ClientUnaryCall;
/**
* Gets the possible CAN channel bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN channel bus speeds.
*/
getCanChannelBusSpeeds(request: GetCanChannelBusSpeedsRequest, callback: (error: ServiceError | null, response: GetCanChannelBusSpeedsResponse) => void): ClientUnaryCall;
getCanChannelBusSpeeds(request: GetCanChannelBusSpeedsRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetCanChannelBusSpeedsResponse) => void): ClientUnaryCall;
getCanChannelBusSpeeds(request: GetCanChannelBusSpeedsRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetCanChannelBusSpeedsResponse) => void): ClientUnaryCall;
/**
* Gets the possible classic CAN bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible classic CAN bus speeds.
*/
getClassicCanBusSpeeds(request: GetClassicCanBusSpeedsRequest, callback: (error: ServiceError | null, response: GetClassicCanBusSpeedsResponse) => void): ClientUnaryCall;
getClassicCanBusSpeeds(request: GetClassicCanBusSpeedsRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetClassicCanBusSpeedsResponse) => void): ClientUnaryCall;
getClassicCanBusSpeeds(request: GetClassicCanBusSpeedsRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetClassicCanBusSpeedsResponse) => void): ClientUnaryCall;
/**
* Gets the possible CAN-FD bus speeds.
* @param request A request message with information about the device to get bus speeds for.
* @returns A response message with the possible CAN-FD bus speeds.
*/
getCanFdBusSpeeds(request: GetCanFdBusSpeedsRequest, options?: Partial<CallOptions>): ClientReadableStream<GetCanFdBusSpeedsResponse>;
getCanFdBusSpeeds(request: GetCanFdBusSpeedsRequest, metadata?: Metadata, options?: Partial<CallOptions>): ClientReadableStream<GetCanFdBusSpeedsResponse>;
}
export declare const DeviceServiceClient: {
new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): DeviceServiceClient;
service: typeof DeviceServiceService;
serviceName: string;
};