@types/rsocket-core/RSocketFrame.d.ts

TypeScript definitions for rsocket-core

import { ErrorFrame, Frame } from "rsocket-types";
export const CONNECTION_STREAM_ID = 0;
export const FRAME_TYPES: {
    CANCEL: number;
    ERROR: number;
    EXT: number;
    KEEPALIVE: number;
    LEASE: number;
    METADATA_PUSH: number;
    PAYLOAD: number;
    REQUEST_CHANNEL: number;
    REQUEST_FNF: number;
    REQUEST_N: number;
    REQUEST_RESPONSE: number;
    REQUEST_STREAM: number;
    RESERVED: number;
    RESUME: number;
    RESUME_OK: number;
    SETUP: number;
};
export const FRAME_TYPE_NAMES: {};
export const FLAGS: {
    COMPLETE: number;
    FOLLOWS: number;
    IGNORE: number;
    LEASE: number;
    METADATA: number;
    NEXT: number;
    RESPOND: number;
    RESUME_ENABLE: number;
};
export const ERROR_CODES: {
    APPLICATION_ERROR: number;
    CANCELED: number;
    CONNECTION_CLOSE: number;
    CONNECTION_ERROR: number;
    INVALID: number;
    INVALID_SETUP: number;
    REJECTED: number;
    REJECTED_RESUME: number;
    REJECTED_SETUP: number;
    RESERVED: number;
    RESERVED_EXTENSION: number;
    UNSUPPORTED_SETUP: number;
};
export const ERROR_EXPLANATIONS: {};
export const FLAGS_MASK = 1023;
export const FRAME_TYPE_OFFFSET = 10;
export const MAX_CODE = 2147483647;
export const MAX_KEEPALIVE = 2147483647;
export const MAX_LIFETIME = 2147483647;
export const MAX_METADATA_LENGTH = 16777215;
export const MAX_MIME_LENGTH = 255;
export const MAX_REQUEST_COUNT = 2147483647;
export const MAX_REQUEST_N = 2147483647;
export const MAX_RESUME_LENGTH = 65535;
export const MAX_STREAM_ID = 2147483647;
export const MAX_TTL = 2147483647;
export const MAX_VERSION = 65535;
/**
 * Returns true iff the flags have the IGNORE bit set.
 */
export function isIgnore(flags: number): boolean;
/**
 * Returns true iff the flags have the METADATA bit set.
 */
export function isMetadata(flags: number): boolean;
/**
 * Returns true iff the flags have the COMPLETE bit set.
 */
export function isComplete(flags: number): boolean;
/**
 * Returns true iff the flags have the NEXT bit set.
 */
export function isNext(flags: number): boolean;
/**
 * Returns true iff the flags have the RESPOND bit set.
 */
export function isRespond(flags: number): boolean;
/**
 * Returns true iff the flags have the RESUME_ENABLE bit set.
 */
export function isResumeEnable(flags: number): boolean;
/**
 * Returns true iff the flags have the LEASE bit set.
 */
export function isLease(flags: number): boolean;
/**
 * Returns true iff the frame type is counted toward the implied
 * client/server position used for the resumption protocol.
 */
export function isResumePositionFrameType(type: number): boolean;
export function getFrameTypeName(type: number): string;
/** Metadata about the error for use in introspecting at runtime. */
export interface ErrorSource {
    /** The error code returned by the server. */
    code: number;
    /** Human-readable explanation of the code (this value is not standardized and may change). */
    explanation: string;
    /** The error string returned by the server. */
    message: string;
}
/**
 * Constructs an Error object given the contents of an error frame.
 */
export function createErrorFromFrame(frame: ErrorFrame): Error & { source: ErrorSource };
/**
 * Given a RSocket error code, returns a human-readable explanation of that
 * code, following the names used in the protocol specification.
 */
export function getErrorCodeExplanation(code: number): string;
/**
 * Pretty-prints the frame for debugging purposes, with types, flags, and
 * error codes annotated with descriptive names.
 */
export function printFrame(frame: Frame): string;