package
0.0.0-20240211223707-1bc40cc9b8e6
Repository: https://github.com/kingcobra2468/cot.git
Documentation: pkg.go.dev
# Functions
AddClient adds a client number to a given service's whitelist.
ClientAuthorized checks if a client number is authorized to use a given service.
ClientExists checks if a client number has previously been recorded.
GenerateServices creates a list of services that were specified from the configuration file.
NewCache creates a new Cache instance.
# Constants
BoolType describes that the cast will be made to the bool type.
EndpointArg describes an argument that will be used to construct the endpoint URL.
FloatType describes that the cast will be made to the float type.
IntType describes that the cast will be made to the int type.
InvalidArg describes an argument whose type that was specified in the configuration but does not exist within cot.
InvalidResponse describes a response type that was specified for a given command but does not exist within cot.
InvalidType describes a type that was specified but does not exist within cot.
JsonArg describes an argument that is designated for the JSON body.
JsonResponse describes a response type where the output will be further processed through JSON.
PlainTextResponse describes a response type where the raw response is sent back to the user.
QueryArg describes an argument that is designated for the query params.
StringType describes that the cast will be made to the string type.
# Structs
Arg represents the metadata about a given input command argument.
Cache contains a goroutine-safe client pool for services.
Command represents the metadata of a given command.
Commands represents the global schematics of all commands for a given client service.
Response describes how to process the output of the client service and address cases of successful and erroneous output.
Service handles the communication between a command request and the associated client service.
TypeInfo describes the metadata about a given argument and response attribute.
UserInput sets up the schema for a command request via the name of a command and its its arguments.
# Type aliases
Mapping between the positional index of an argument of the input command and its corresponding metadata.
Command input arg datatype.
Mapping between a command input arg type and the corresponding arguments for that given arg type.
Command input arg type.
The set of supported HTTP methods when sending commands to a client service.
Command output response type.