prosody
41c959c5c84b
doc/session.txt
Software / code / prosody
Comparison
doc/session.txt @ 8728:41c959c5c84b
Fix spelling throughout the codebase [codespell]
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 04 Feb 2018 01:51:25 +0100 |
| parent | 7535:4a3a3098d9bb |
comparison
equal
deleted
inserted
replaced
| 8727:285075a27f28 | 8728:41c959c5c84b |
|---|---|
| 13 host -- the host part of the client's jid (not defined before stream initiation) | 13 host -- the host part of the client's jid (not defined before stream initiation) |
| 14 resource -- the resource part of the client's full jid (not defined before resource binding) | 14 resource -- the resource part of the client's full jid (not defined before resource binding) |
| 15 full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding) | 15 full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding) |
| 16 priority -- the resource priority, default: 0 | 16 priority -- the resource priority, default: 0 |
| 17 presence -- the last non-directed presence with no type attribute. initially nil. reset to nil on unavailable presence. | 17 presence -- the last non-directed presence with no type attribute. initially nil. reset to nil on unavailable presence. |
| 18 interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil. | 18 interested -- true if the resource requested the roster. Interested resources receive roster updates. Initially nil. |
| 19 roster -- the user's roster. Loaded as soon as the resource is bound (session becomes a connected resource). | 19 roster -- the user's roster. Loaded as soon as the resource is bound (session becomes a connected resource). |
| 20 | 20 |
| 21 -- methods -- | 21 -- methods -- |
| 22 send(x) -- converts x to a string, and writes it to the connection | 22 send(x) -- converts x to a string, and writes it to the connection |
| 23 close(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases | 23 close(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases |
