Generated Code
ThreadButler generates a fair amount of types and procs. This page exists as a reference to list all of them out and provide doc-comments for them.
The sections are in the order that the type/proc-code-snippets are emitted by threadButler. They are prefixed with the macro that emits them.
threadServer: type <ThreadName>Kinds = enum
Enum representing all kinds of messages a given ThreadServer can receive. It is used to generate the Message-Wrapper-Type.
Includes 1 kind per registered type + 1 Kill
threadServer: type <ThreadName>Message = object
The Message-Wrapper-Type. Object variant capable of wrapping any message-type that can be sent to a ThreadServer. Instances of this type are always sent to the Channel associated with it and thus to the associated ThreadServer.
threadServer: proc sendMessage
A proc of shape: proc sendMessage*(hub: ChannelHub, msg: sink msgType): bool
Tries to send a message through the ChannelHub. Returns true if that succeeded, false if it didn't - because the channel was full - and the message was dropped.
threadServer: proc sendKillMessage
Procs generated to send killMessages to individual servers.
threadServer: proc initServer
A proc used by threadButler internally to instantiate Server
objects.
threadServer: var ButlerThread
A global mutable variable containing a thread.
This is for the thread to run specifically the threadServer associated with threadname.
prepareServers: proc new(ChannelHub)
Constructor for ChannelHub. Only calls this proc once to have a single instance that you pass around.
prepareServers: proc destroy(ChannelHub)
Destructor for ChannelHub. Only call this proc once to destroy the single ChannelHub instance that you have.
prepareServers: handler procs
Procs added to the handlers section of each threadServer are spawned here.
This allows threadButler to guarantee that a handler has access to all types of other threadServers once they are generated.
That way, even without the importing the types of other threadservers, you can send messages to them as the place where "prepareServers" gets called is the place where the procs will appear.
prepareServers: proc routeMessage
The routing proc generated per threadServer.