SwiftHooks Class Reference


                    
                    
                    eventLoopGroup

EventLoopGroup this application runs on.

Declaration

Swift

public let eventLoopGroup: EventLoopGroup

Show on GitHub


                    
                    
                    didShutdown

Wether or not SwiftHooks did shutdown.

Declaration

Swift

public private(set) var didShutdown: Bool { get }

Show on GitHub


                    
                    
                    config

Config used for this SwiftHooks instance.

Declaration

Swift

public let config: SwiftHooksConfig

Show on GitHub


                    
                    
                    hooks

Registered _Hooks.

Declaration

Swift

public internal(set) var hooks: [_Hook] { get }

Show on GitHub


                    
                    
                    globalListeners

Registered GlobalListeners.

Declaration

Swift

public internal(set) var globalListeners: [GlobalEvent : [GlobalEventClosure]] { get }

Show on GitHub


                    
                    
                    commands

Registered ExecutableCommands

Declaration

Swift

public internal(set) var commands: [_ExecutableCommand] { get }

Show on GitHub


                    
                    
                    plugins

Registered Plugins.

Declaration

Swift

public internal(set) var plugins: [_Plugin] { get }

Show on GitHub


                    
                    
                    decoder

Global JSONDecoder

Declaration

Swift

public static let decoder: JSONDecoder

Show on GitHub


                    
                    
                    encoder

Global JSONEncoder

Declaration

Swift

public static let encoder: JSONEncoder

Show on GitHub


                    
                    
                    init(eventLoopGroup:config:)

Create a new SwiftHooks instance

Declaration

Swift

public init(eventLoopGroup: EventLoopGroup? = nil, config: SwiftHooksConfig = .default)

Parameters

`eventLoopGroup`	EventLoopGroup to run SwiftHooks on. If not passed in a new one will be created.
`config`	Configuration to use. Defaults to `SwiftHooksConfig.default`

Show on GitHub


                    
                    
                    run()

Run the SwiftHooks process. Will boot all connected Hooks and block forever.

Declaration

Swift

public func run() throws

Show on GitHub


                    
                    
                    hook(_:)

Connect a new _Hook to the SwiftHooks system.

Declaration

Swift

public func hook(_ hook: _Hook) throws

Parameters


                                hook

Instance of _Hook or Hook

Show on GitHub


                    
                    
                    hook(_:_:)

Add a Hook to the SwiftHooks class.

try swiftHooks.hook(MyHook.self, MyHookOptions(...))

Declaration

Swift

func hook<H, O>(_ hook: H.Type, _ options: O) throws where H : Hook, O == H.Options

Parameters

`hook`	Hook type to connect.
`options`	Options required to initialize the hook.

Show on GitHub


                    
                    
                    dispatchEvent(_:with:from:on:)

Dispatch an event from a _Hook into the central SwiftHooks system.

Declaration

Swift

public func dispatchEvent<E>(_ e: E, with raw: Data, from h: _Hook, on eventLoop: EventLoop) -> EventLoopFuture<Void> where E : EventType

Parameters

`e`	Event to dispatch
`raw`	Raw bytes containing the event.
`h`	Hook this event originated from.

Show on GitHub


                    
                    
                    register(_:)

Register a plugin to the SwiftHooks system.

swiftHooks.register(MyPlugin())

This will add all commands & listeners in the plugin to all registered hooks.

Declaration

Swift

public func register<P>(_ plugin: P) throws where P : Plugin

Parameters


                                plugin

Plugin to register

Show on GitHub


                    
                    
                    logger

Global SwiftHooks logger

Declaration

Swift

public static var logger: Logger { get }

Show on GitHub


                    
                    
                    logger

Global SwiftHooks logger

Declaration

Swift

public var logger: Logger { get }

Show on GitHub