json_rpc/servers/httpserver

Search:
Group by:
Source   Edit  

Types

HttpAuthHook = proc (request: HttpRequestRef): Future[HttpResponseRef] {.
    async: (...raises: [CatchableError]).}
Source   Edit  
RpcHttpHandler = ref object of RpcServer
  maxChunkSize* {....deprecated.}: int
Source   Edit  
RpcHttpServer = ref object of RpcHttpHandler
Source   Edit  

Procs

proc addHttpServer(rpcServer: RpcHttpServer; address: TransportAddress;
                   socketFlags: set[ServerFlags] = {TcpNoDelay, ReuseAddr};
                   serverUri = Uri(); serverIdent = "";
                   maxConnections: int = -1; bufferSize: int = 4096;
                   backlogSize: int = 100; httpHeadersTimeout = 10.seconds;
                   maxHeadersSize: int = 8192;
                   maxRequestBodySize: int = defaultMaxMessageSize) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addHttpServer(server: RpcHttpServer; address: string) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Create new server and assign it to addresses addresses. Source   Edit  
proc addHttpServer(server: RpcHttpServer; address: string; port: Port) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addHttpServers(server: RpcHttpServer; addresses: openArray[string]) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addHttpServers(server: RpcHttpServer;
                    addresses: openArray[TransportAddress]) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Start a server on at least one of the given addresses, or raise Source   Edit  
proc addSecureHttpServer(rpcServer: RpcHttpServer; address: TransportAddress;
                         tlsPrivateKey: TLSPrivateKey;
                         tlsCertificate: TLSCertificate; socketFlags: set[
    ServerFlags] = {TcpNoDelay, ReuseAddr}; serverUri = Uri();
                         serverIdent: string = JsonRpcIdent;
                         secureFlags: set[TLSFlags] = {};
                         maxConnections: int = -1; backlogSize: int = 100;
                         bufferSize: int = 4096;
                         httpHeadersTimeout = 10.seconds;
                         maxHeadersSize: int = 8192;
                         maxRequestBodySize: int = defaultMaxMessageSize) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addSecureHttpServer(server: RpcHttpServer; address: string;
                         tlsPrivateKey: TLSPrivateKey;
                         tlsCertificate: TLSCertificate) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addSecureHttpServer(server: RpcHttpServer; address: string; port: Port;
                         tlsPrivateKey: TLSPrivateKey;
                         tlsCertificate: TLSCertificate) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Source   Edit  
proc addSecureHttpServers(server: RpcHttpServer;
                          addresses: openArray[TransportAddress];
                          tlsPrivateKey: TLSPrivateKey;
                          tlsCertificate: TLSCertificate) {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Start a server on at least one of the given addresses, or raise Source   Edit  
proc closeWait(server: RpcHttpServer): InternalRaisesFuture[void, void] {.
    ...stackTrace: false, raises: [], gcsafe, raises: [], gcsafe,
    tags: [RootEffect], forbids: [].}
Cleanup resources of RPC server. Source   Edit  
proc localAddress(server: RpcHttpServer): seq[TransportAddress] {....raises: [],
    gcsafe, tags: [], forbids: [].}
Source   Edit  
proc new(T: type RpcHttpServer; authHooks: seq[HttpAuthHook] = @[]): T:type {.
    ...raises: [], gcsafe.}
Source   Edit  
proc new(T: type RpcHttpServer; router: RpcRouter;
         authHooks: seq[HttpAuthHook] = @[]): T:type {....raises: [], gcsafe.}
Source   Edit  
proc newRpcHttpServer(addresses: openArray[string];
                      authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Create new server and assign it to addresses addresses. Source   Edit  
proc newRpcHttpServer(addresses: openArray[string]; router: RpcRouter;
                      authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Create new server and assign it to addresses addresses. Source   Edit  
proc newRpcHttpServer(addresses: openArray[TransportAddress];
                      authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Create new server and assign it to addresses addresses. Source   Edit  
proc newRpcHttpServer(addresses: openArray[TransportAddress]; router: RpcRouter;
                      authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [JsonRpcError], raises: [], gcsafe,
    tags: [RootEffect, WriteIOEffect], forbids: [].}
Create new server and assign it to addresses addresses. Source   Edit  
proc newRpcHttpServer(authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc newRpcHttpServer(router: RpcRouter; authHooks: seq[HttpAuthHook] = @[]): RpcHttpServer {.
    ...raises: [], gcsafe, tags: [], forbids: [].}
Source   Edit  
proc serveHTTP(rpcServer: RpcHttpHandler; request: HttpRequestRef): InternalRaisesFuture[
    HttpResponseRef, (CancelledError,)] {....stackTrace: false, raises: [], gcsafe,
    raises: [], gcsafe, tags: [RootEffect], forbids: [].}
Source   Edit  
proc setMaxChunkSize(server: RpcHttpServer; maxChunkSize: int) {.
    ...deprecated: "unused", raises: [], gcsafe, tags: [], forbids: [].}
Deprecated: unused
Source   Edit  
proc start(server: RpcHttpServer) {....raises: [], gcsafe,
                                    tags: [RootEffect, WriteIOEffect],
                                    forbids: [].}
Start the RPC server. Source   Edit  
proc stop(server: RpcHttpServer): InternalRaisesFuture[void, void] {.
    ...stackTrace: false, raises: [], gcsafe, raises: [], gcsafe,
    tags: [RootEffect], forbids: [].}
Stop the RPC server. Source   Edit  

Exports

$, ==, 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