Index

Modules: guildenstern/dispatcher, guildenstern/guildenserver, guildenstern/httpserver, guildenstern/streamingserver, guildenstern/websocketserver.

API symbols

AlreadyClosed:

• guildenserver: SocketCloseCause.AlreadyClosed

Binary:

• websocketserver: Opcode.Binary

Close:

• websocketserver: Opcode.Close

CloseCalled:

• guildenserver: SocketCloseCause.CloseCalled

ClosedbyClient:

• guildenserver: SocketCloseCause.ClosedbyClient

closeOtherSocket:

• guildenserver: proc closeOtherSocket(server: GuildenServer; socket: posix.SocketHandle; cause: SocketCloseCause = CloseCalled; msg: string = "")

closeSocket:

• guildenserver: proc closeSocket(cause = CloseCalled; msg = "")

Complete:

• httpserver: SocketState.Complete

ConnectionLost:

• guildenserver: SocketCloseCause.ConnectionLost

Cont:

• websocketserver: Opcode.Cont

DEBUG:

• guildenserver: LogLevel.DEBUG

DontClose:

• guildenserver: SocketCloseCause.DontClose

ERROR:

• guildenserver: LogLevel.ERROR

Excepted:

• guildenserver: SocketCloseCause.Excepted

Fail:

• httpserver: SocketState.Fail

FATAL:

• guildenserver: LogLevel.FATAL

getBody:

• httpserver: proc getBody(): string

getBodylen:

• httpserver: proc getBodylen(): int

getMessage:

• websocketserver: proc getMessage(): string

getMethod:

• httpserver: proc getMethod(): string

getRequest:

• httpserver: proc getRequest(): string

getUri:

• httpserver: proc getUri(): string

GuildenServer:

• guildenserver: type GuildenServer

GuildenSternVersion:

• guildenserver: const GuildenSternVersion

hasData:

• streamingserver: proc hasData(): bool

http:

• httpserver: template http(): untyped

HttpContext:

• httpserver: type HttpContext

HttpServer:

• httpserver: type HttpServer

INFO:

• guildenserver: LogLevel.INFO

isBody:

• httpserver: proc isBody(body: string): bool

isHttpContext:

• httpserver: proc isHttpContext(): bool

isMessage:

• websocketserver: proc isMessage(message: string): bool

isMethod:

• httpserver: proc isMethod(amethod: string): bool

isStreamingContext:

• streamingserver: proc isStreamingContext(): bool

isUri:

• httpserver: proc isUri(uri: string): bool

isWebsocketContext:

• websocketserver: proc isWebsocketContext(): bool

log:

• guildenserver: template log(theserver: GuildenServer; level: LogLevel; message: string)

LogCallback:

• guildenserver: type LogCallback

LogLevel:

• guildenserver: enum LogLevel

NetErrored:

• guildenserver: SocketCloseCause.NetErrored

newHttpServer:

• httpserver: proc newHttpServer(onrequestcallback: proc () {.gcsafe, nimcall, raises: [].}; loglevel = LogLevel.WARN; parserequestline = true; hascontent = true): HttpServer

newStreamingServer:

• streamingserver: proc newStreamingServer(onrequestcallback: proc () {.gcsafe, nimcall, raises: [].}; loglevel = LogLevel.WARN): HttpServer

newWebsocketServer:

• websocketserver: proc newWebsocketServer(upgradecallback: WsUpgradeCallback; afterupgradecallback: WsAfterUpgradeCallback; onwsmessagecallback: WsMessageCallback; onclosesocketcallback: OnCloseSocketCallback; loglevel = LogLevel.WARN): WebsocketServer

NONE:

• guildenserver: LogLevel.NONE

NOTICE:

• guildenserver: LogLevel.NOTICE

OnCloseSocketCallback:

• guildenserver: type OnCloseSocketCallback

Opcode:

• websocketserver: enum Opcode

parseAllHeaders:

• httpserver: proc parseAllHeaders(headers: StringTableRef)

parseHeaders:

• httpserver: proc parseHeaders(fields: openArray[string]; toarray: var openArray[string])

Ping:

• websocketserver: Opcode.Ping

Pong:

• websocketserver: Opcode.Pong

Progress:

• httpserver: SocketState.Progress

ProtocolViolated:

• guildenserver: SocketCloseCause.ProtocolViolated

receiveChunk:

• streamingserver: proc receiveChunk(): SocketState

receiveMultipart:

• streamingserver: proc receiveMultipart(): (SocketState, string)

reply:

• httpserver: proc reply(code: HttpCode): SocketState
• httpserver: proc reply(code: HttpCode; body: ptr string; headers: openArray[string])
• httpserver: proc reply(code: HttpCode; body: ptr string; headers: ptr string)
• httpserver: template reply(code: HttpCode; headers: openArray[string])
• httpserver: template reply(code: HttpCode; body: string)
• httpserver: template reply(code: HttpCode; body: string; headers: openArray[string])
• httpserver: template reply(body: string)
• httpserver: template reply(body: string; headers: openArray[string])

replyFinish:

• httpserver: proc replyFinish(): SocketState

replyMore:

• httpserver: proc replyMore(bodypart: ptr string; start: int; partlength: int = -1): (SocketState, int)
• httpserver: template replyMore(bodypart: string): bool

replyStart:

• httpserver: proc replyStart(code: HttpCode; contentlength: int; headers: openArray[string]): SocketState
• httpserver: proc replyStart(code: HttpCode; contentlength: int; headers: ptr string = nil): SocketState

SecurityThreatened:

• guildenserver: SocketCloseCause.SecurityThreatened

send:

• websocketserver: proc send(server: GuildenServer; socket: posix.SocketHandle; message: string; timeoutsecs = 20; sleepmillisecs = 100): bool
• websocketserver: proc send(server: GuildenServer; delivery: ptr WsDelivery; timeoutsecs = 20; sleepmillisecs = 100): int
• websocketserver: proc send(server: GuildenServer; sockets: seq[posix.SocketHandle]; message: string; timeoutsecs = 20; sleepmillisecs = 100): bool

sendPong:

• websocketserver: proc sendPong(server: GuildenServer; socket: posix.SocketHandle)

server:

• httpserver: template server(): untyped

shutdown:

• guildenserver: proc shutdown()

shuttingdown:

• guildenserver: var shuttingdown

SocketCloseCause:

• guildenserver: enum SocketCloseCause

SocketContext:

• guildenserver: type SocketContext

socketcontext:

• guildenserver: var socketcontext

SocketData:

• guildenserver: object SocketData

SocketState:

• httpserver: enum SocketState

start:

• dispatcher: proc start(server: GuildenServer; port: int; threadpoolsize: uint = 0; maxactivethreadcount: uint = 0)

startReceiveMultipart:

• streamingserver: proc startReceiveMultipart(waitMs = 100; giveupSecs = 10): bool

startsUri:

• httpserver: proc startsUri(uristart: string): bool

stream:

• streamingserver: template stream(): untyped

StreamingContext:

• streamingserver: type StreamingContext

suspend:

• guildenserver: proc suspend(sleepmillisecs: int)

Text:

• websocketserver: Opcode.Text

TimedOut:

• guildenserver: SocketCloseCause.TimedOut

TRACE:

• guildenserver: LogLevel.TRACE

TryAgain:

• httpserver: SocketState.TryAgain

WARN:

• guildenserver: LogLevel.WARN

WebsocketContext:

• websocketserver: type WebsocketContext

WebsocketServer:

• websocketserver: type WebsocketServer

ws:

• websocketserver: template ws(): untyped

WsAfterUpgradeCallback:

• websocketserver: type WsAfterUpgradeCallback

WsDelivery:

• websocketserver: tuple WsDelivery

WsFail:

• websocketserver: Opcode.WsFail

WsMessageCallback:

• websocketserver: type WsMessageCallback

wsserver:

• websocketserver: template wsserver(): untyped

WsUpgradeCallback:

• websocketserver: type WsUpgradeCallback