json_rpc/servers/websocketserver

Search:
Group by:
Source   Edit  

Types

RpcWebSocketHandler = ref object of RpcServer
  wsserver*: WSServer
  maxMessageSize*: int
Source   Edit  
WsAuthHook = proc (request: HttpRequest): Future[bool] {.
    async: (...raises: [CatchableError]).}
Source   Edit  

Procs

proc close(server: RpcWebSocketServer) {....raises: [], gcsafe, tags: [],
    forbids: [].}
Cleanup resources of RPC server. Source   Edit  
proc closeWait(server: RpcWebSocketServer): InternalRaisesFuture[void, void] {.
    ...stackTrace: false, raises: [], gcsafe, raises: [], gcsafe,
    tags: [RootEffect], forbids: [].}
Cleanup resources of RPC server. Source   Edit  
proc localAddress(server: RpcWebSocketServer): TransportAddress {....raises: [],
    gcsafe, tags: [], forbids: [].}
Source   Edit  
proc newRpcWebSocketServer(address: TransportAddress; compression: bool = false;
                           flags: set[ServerFlags] = {TcpNoDelay, ReuseAddr};
                           authHooks: seq[WsAuthHook] = @[];
                           rng = HmacDrbgContext.new();
                           maxMessageSize = defaultMaxMessageSize): RpcWebSocketServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc newRpcWebSocketServer(address: TransportAddress;
                           tlsPrivateKey: TLSPrivateKey;
                           tlsCertificate: TLSCertificate;
                           compression: bool = false;
                           flags: set[ServerFlags] = {TcpNoDelay, ReuseAddr};
                           tlsFlags: set[TLSFlags] = {};
                           tlsMinVersion = TLSVersion.TLS12;
                           tlsMaxVersion = TLSVersion.TLS12;
                           authHooks: seq[WsAuthHook] = @[];
                           rng = HmacDrbgContext.new();
                           maxMessageSize = defaultMaxMessageSize): RpcWebSocketServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc newRpcWebSocketServer(host: string; port: Port; compression: bool = false;
                           flags: set[ServerFlags] = {TcpNoDelay, ReuseAddr};
                           authHooks: seq[WsAuthHook] = @[];
                           rng = HmacDrbgContext.new();
                           maxMessageSize = defaultMaxMessageSize): RpcWebSocketServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc newRpcWebSocketServer(host: string; port: Port;
                           tlsPrivateKey: TLSPrivateKey;
                           tlsCertificate: TLSCertificate;
                           compression: bool = false;
                           flags: set[ServerFlags] = {TcpNoDelay, ReuseAddr};
                           tlsFlags: set[TLSFlags] = {};
                           tlsMinVersion = TLSVersion.TLS12;
                           tlsMaxVersion = TLSVersion.TLS12;
                           authHooks: seq[WsAuthHook] = @[];
                           rng = HmacDrbgContext.new()): RpcWebSocketServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc serveHTTP(rpc: RpcWebSocketHandler; request: HttpRequest): InternalRaisesFuture[
    void, (CancelledError,)] {....stackTrace: false, raises: [], gcsafe,
                               raises: [], gcsafe, tags: [RootEffect],
                               forbids: [].}
Source   Edit  
proc start(server: RpcWebSocketServer) {....raises: [JsonRpcError], raises: [],
    gcsafe, tags: [RootEffect, WriteIOEffect], forbids: [].}
Start the RPC server. Source   Edit  
proc stop(server: RpcWebSocketServer) {....raises: [], gcsafe,
                                        tags: [RootEffect, WriteIOEffect],
                                        forbids: [].}
Stop the RPC server. Source   Edit  

Exports

ApplicationError, ErrorResponse, FailedHttpResponse, InvalidRequest, InvalidResponse, JsonRpcError, ParamsMismatchError, RequestDecodeError, ResultDecodeError, RpcAddressUnresolvableError, RpcApplicationError, RpcBindError, RpcInternalError, RpcInvalidParamsError, RpcInvalidRequestError, RpcMethodNotFoundError, RpcOrigin, RpcParseError, RpcPostError, RpcResponseError, RpcServerError, RpcTransportError, new, $, ==, ApplicationError, BidiMessage, BidiMessageKind, BidiMessageRequestError, BidiMessageResponseError, ErrorResponse, FailedHttpResponse, GetJsonRpcRequestHeaders, INTERNAL_ERROR, INVALID_PARAMS, InvalidRequest, INVALID_REQUEST, InvalidRequestSysError, InvalidResponse, JrpcConv, JrpcSys, JSON_ENCODE_ERROR, JSON_PARSE_ERROR, JsonRPC2, JsonRpcError, METHOD_NOT_FOUND, ParamDescNamed, ParamDescRx, ParamsMismatchError, PreferredOutputType, PreferredOutputType, Reader, Reader, ReBatchKind, ReqRespHeader, RequestBatchRx, RequestDecodeError, RequestId, RequestIdKind, RequestParamKind, RequestParamsRx, RequestParamsTx, RequestRx, RequestRx2, RequestTx, ResponseBatchRx, ResponseError, ResponseFut, ResponseKind, ResponseRx, ResponseRx2, ResponseTx, ResultDecodeError, RpcAddressUnresolvableError, RpcApplicationError, RpcBatchCallRef, RpcBatchItem, RpcBatchResponse, RpcBindError, RpcClient, RpcConnection, RpcInternalError, RpcInvalidParamsError, RpcInvalidRequestError, RpcMethodNotFoundError, RpcOrigin, RpcParseError, RpcPostError, RpcProc, RpcResponseError, RpcRouter, RpcRouterCallback, RpcServer, RpcServerError, RpcTransportError, SERVER_ERROR, Writer, Writer, automaticBuiltinSerialization, automaticBuiltinSerialization, automaticPrimitivesSerialization, automaticPrimitivesSerialization, automaticSerialization, automaticSerialization, call, call, call, callOnProcessMessage, clear, clearPending, close, createRpcSigs, createRpcSigs, createRpcSigsFromNim, createRpcSigsFromNim, createRpcSigsFromString, createRpcSigsFromString, createSingleRpcSig, createSingleRpcSig, decode, decode, defaultMaxMessageSize, executeMethod, executeMethod, executeMethod, executeMethod, flavorAllowsUnknownFields, flavorAllowsUnknownFields, flavorEnumRep, flavorEnumRep, flavorEnumRep, flavorEnumRep, flavorOmitsOptionalFields, flavorOmitsOptionalFields, flavorRequiresAllFields, flavorRequiresAllFields, flavorSkipNullFields, flavorSkipNullFields, flavorUsesAutomaticObjectSerialization, flavorUsesAutomaticObjectSerialization, hash, hash, hasMethod, hasMethod, init, isFieldExpected, meth, meth, mimeType, mimeType, new, new, notify, notify, parseResponse, prepareBatch, processMessage, processsSingleResponse, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, register, register, route, route, route, route, route, rpc, rpc, rpc, rpc, rpc, rpc, send, send, shouldWriteObjectField, toJsonError, toTx, typeAutoSerialize, typeAutoSerialize, typeClassOrMemberAutoSerialize, typeClassOrMemberAutoSerialize, unRegisterAll, withPendingFut, withWriter, wrapError, writeNotification, writeRequest, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue