jabber-si-common.el

   1 ;;; jabber-si-common.el --- stream initiation (JEP-0095)
   2
   3 ;; Copyright (C) 2006  Magnus Henoch
   4
   5 ;; Author: Magnus Henoch <mange@freemail.hu>
   6
   7 ;; This file is free software; you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation; either version 2, or (at your option)
  10 ;; any later version.
  11
  12 ;; This file is distributed in the hope that it will be useful,
  13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;; GNU General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  19 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 ;; Boston, MA 02110-1301, USA.
  21
  22 (defvar jabber-si-stream-methods nil
  23   "Supported SI stream methods.
  24
  25 Each entry is a list, containing:
  26  * The namespace URI of the stream method
  27  * Active initiation function
  28  * Passive initiation function
  29
  30 The active initiation function should initiate the connection,
  31 while the passive initiation function should wait for an incoming
  32 connection.  Both functions take the same arguments:
  33
  34  * JID of peer
  35  * SID
  36  * \"connection established\" function
  37
  38 The \"connection established\" function should be called when the
  39 stream has been established and data can be transferred.  It is part
  40 of the profile, and takes the following arguments:
  41
  42  * JID of peer
  43  * SID
  44  * Either:
  45     - \"send data\" function, with one string argument
  46     - an error message, when connection failed
  47
  48 It returns an \"incoming data\" function.
  49
  50 The \"incoming data\" function should be called when data arrives on
  51 the stream.  It takes these arguments:
  52
  53  * JID of peer
  54  * SID
  55  * A string containing the received data, or nil on EOF
  56
  57 If it returns nil, the stream should be closed.")
  58
  59 (provide 'jabber-si-common)
  60 ;; arch-tag: 9e7a5c8a-bdde-11da-8030-000a95c2fcd0
  61 ;;; jabber-si-common.el ends here