Client.CApi

Foreign interface to the IRC client via a simple C API and dynamically loaded modules.

Extension type

data ActiveExtension

Information about a loaded extension including the handle to the loaded shared object, and state value returned by the startup callback, and the loaded extension record.

Constructors

ActiveExtension

Fields

• aeFgn :: !FgnExtension

  Struct of callback function pointers

• aeDL :: !DL

  Handle of dynamically linked extension

• aeSession :: !(Ptr ())

  State value generated by start callback

• aeName :: !Text
• aeMajorVersion, aeMinorVersion :: !Int
• aeTimers :: !(IntPSQ UTCTime TimerEntry)
• aeNextTimer :: !Int
• aeThreads :: !Int
• aeLive :: !Bool

Extension callbacks

extensionSymbol :: String

The symbol that is loaded from an extension object.

Extensions are expected to export:

struct galua_extension extension;

openExtension

Arguments

:: ExtensionConfiguration

extension configuration

-> IO ActiveExtension

Load the extension from the given path and call the start callback. The result of the start callback is saved to be passed to any subsequent calls into the extension.

startExtension

Arguments

:: Ptr ()

client stable pointer

-> ExtensionConfiguration

extension configuration

-> ActiveExtension

active extension

-> IO (Ptr ())

extension state

stopExtension :: ActiveExtension -> IO ()

notifyExtension

Arguments

:: ActiveExtension

extension

-> Ptr FgnMsg

serialized IRC message

-> IO Bool

allow message

Call all of the process message callbacks in the list of extensions. This operation marshals the IRC message once and shares that across all of the callbacks.

Returns True to pass message to client. Returns 'False to drop message.

commandExtension

Arguments

:: Text

command

-> ActiveExtension

extension to command

-> IO ()

Notify an extension of a client command with the given parameters.

chatExtension

Arguments

:: ActiveExtension

extension

-> Ptr FgnChat

serialized chat message

-> IO Bool

allow message

Call all of the process chat callbacks in the list of extensions. This operation marshals the IRC message once and shares that across all of the callbacks.

Returns True to pass message to client. Returns 'False to drop message.

data ThreadEntry

Constructors

ThreadEntry !(FunPtr ThreadFinish) !(Ptr ())

threadFinish :: ThreadEntry -> IO ()

Notify an extension that one of its threads has finished.

popTimer

Arguments

:: ActiveExtension

extension

-> Maybe (UTCTime, TimerId, FunPtr TimerCallback, Ptr (), ActiveExtension)

earlier time, callback, callback state, updated extension

Find the earliest timer ready to run if any are available.

pushTimer

Arguments

:: UTCTime

activation time

-> FunPtr TimerCallback

callback function

-> Ptr ()

callback state

-> ActiveExtension

extension

-> (Int, ActiveExtension)

Schedue a new timer event for the given extension.

cancelTimer

Arguments

:: Int

timer ID

-> ActiveExtension

extension

-> Maybe (Ptr (), ActiveExtension)

Remove a timer from the schedule by ID

evalNestedIO :: NestedIO a -> IO a

Return the bracket IO action.

withChat

Arguments

:: Text

network

-> Text

target

-> Text

message

-> NestedIO (Ptr FgnChat)

withRawIrcMsg

Arguments

:: Text

network

-> RawIrcMsg

message

-> NestedIO (Ptr FgnMsg)

Marshal a RawIrcMsg into a FgnMsg which will be valid for the remainder of the computation.