annotate doc/cmd-signals.dox @ 23995:85bed17fe5c1

The variable we use to keep track of the watcher of the ssl connection should be unsigned. This isn't really a problem in Pidgin, where we use glib's mainloop and GIOChannels because glib starts assigning the handle IDs sequentially starting from 1. But if an eventloop implementation ever returns a handle ID greater than the largest possible signed integer (2,147,483,647) then we won't be able to remove the watcher because purple_ssl_close() in sslconn.c only removes it if inpa > 0, and since it interprets inpa as a signed value then handles over 2,147,483,647 appear as negative numbers. I stumbled upon this when playing around with libevent, which can use epoll. My implementation generated a random handle ID which was sometimes greater than 2,147,483,647. I don't believe this breaks binary compatibility. And I don't think it breaks source compatibility, but I guess it might depend on what compiler you're using.

/** @page cmd-signals Command Signals
  @signals
  	@signal cmd-added
	@signal cmd-removed
  @endsignals

  @see cmds.h

  @signaldef cmd-added
  	@signalproto
void (*cmd_added)(const char *command, PurpleCmdPriority priority,
                  PurpleCmdFlag flag);
	@endsignalproto
	@signaldesc
	 Emitted when a new command is added.
	@param command   The new command.
	@param priority  The priority of the new command.
	@param flag      The command flags.
  @endsignaldef

  @signaldef cmd-removed
  	@signalproto
void (*cmd_removed)(const char *command);
	@endsignalproto
	@signaldesc
	 Emitted when a command is removed.
	@param command   The removed command.
  @endsignaldef
*/