src/admin.h File Reference

Administration interface. More...

Go to the source code of this file.

Data Structures

struct  admin_handle
 Handle used in the administration subsystem. More...
struct  admin_command
 Administration command. More...

Typedefs

typedef struct admin_handleadmin_handle
typedef void(* admin_command_handler )(admin_handle, char **, void *userdata)

Functions

G_MODULE_EXPORT void register_admin_command (const struct admin_command *cmd)
 Register a new administration command.
G_MODULE_EXPORT void admin_out (admin_handle h, const char *fmt,...)
 Reply to an administration command.
G_MODULE_EXPORT struct irc_clientadmin_get_client (admin_handle h)
 Return the client handle associated with an admin context.
G_MODULE_EXPORT struct
irc_network
admin_get_network (admin_handle h)
 Return the network handle associated with an admin context.
G_MODULE_EXPORT struct globaladmin_get_global (admin_handle h)


Detailed Description

Administration interface.


Function Documentation

G_MODULE_EXPORT struct irc_client* admin_get_client ( admin_handle  h  )  [read]

Return the client handle associated with an admin context.

Parameters:
h Admin context handle
Returns:
Client, or NULL if no client is associated.

G_MODULE_EXPORT struct irc_network* admin_get_network ( admin_handle  h  )  [read]

Return the network handle associated with an admin context.

Parameters:
h Admin context handle
Returns:
Network, or NULL if no network is associated.

G_MODULE_EXPORT void admin_out ( admin_handle  h,
const char *  fmt,
  ... 
)

Reply to an administration command.

Parameters:
h admin handle
fmt printf-style string to send
Reply to an administration command.

Parameters:
h Admin context handle
fmt Format, printf-style
... Format arguments

G_MODULE_EXPORT void register_admin_command ( const struct admin_command cmd  ) 

Register a new administration command.


Generated on Mon Apr 14 00:44:20 2008 for ctrlproxy by  doxygen 1.5.5