File: erc-backend.el.html

This file defines backend network communication handlers for ERC.

How things work:

You define a new handler with define-erc-response-handler. This defines a function, a corresponding hook variable, and populates a global hash table erc-server-responses with a map from response to hook variable. See the function documentation for more information.

Upon receiving a line from the server, erc-parse-server-response is called on it.

A line generally looks like:

LINE := ':' SENDER ' ' COMMAND ' ' (COMMAND-ARGS ' ')* ':' CONTENTS SENDER := Not ':' | ' ' COMMAND := Not ':' | ' ' COMMAND-ARGS := Not ':' | ' '

This gets parsed and stuffed into an erc-response struct. You can access the fields of the struct with:

COMMAND --- erc-response.command COMMAND-ARGS --- erc-response.command-args CONTENTS --- erc-response.contents SENDER --- erc-response.sender LINE --- erc-response.unparsed TAGS --- erc-response.tags

WARNING, WARNING!! It's probably not a good idea to destructively modify the list of command-args in your handlers, since other functions down the line may well need to access the arguments too.

That is, unless you're /absolutely/ sure that your handler doesn't invoke some other function that needs to use COMMAND-ARGS, don't do something like

(while (erc-response.command-args parsed)
  (let ((a (pop (erc-response.command-args parsed))))
    ...))

The parsed response is handed over to erc-handle-parsed-server-response, which checks whether it should carry out duplicate suppression, and then runs erc-call-hooks. erc-call-hooks retrieves the relevant hook variable from erc-server-responses and runs it.

Most handlers then destructure the parsed response in some way
(depending on what the handler is, the arguments have different
meanings), and generally display something, usually using erc-display-message.

Defined variables (154)

Defined functions (161)

Defined faces (0)