diff options
| author | Richard van der Hoff <richard@matrix.org> | 2015-10-21 16:10:02 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2015-10-21 16:10:02 +0100 |
| commit | 79b823a739e7e93e196cc554b1bb53a8631c6244 (patch) | |
| tree | 0ef950a5edf69f7e42c6f445cc4af6cbc3dd0859 /matrix-sync.h | |
| parent | 1a97c621cbaebd8bb5b1ca68f12755977115374a (diff) | |
| download | purple-matrix-79b823a739e7e93e196cc554b1bb53a8631c6244.tar.gz | |
Update README and file comments
Diffstat (limited to 'matrix-sync.h')
| -rw-r--r-- | matrix-sync.h | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/matrix-sync.h b/matrix-sync.h index 21537ac..629f493 100644 --- a/matrix-sync.h +++ b/matrix-sync.h @@ -1,5 +1,13 @@ /** - * Handle the 'sync' loop + * matrix-sync.h + * + * Receipt of events from the matrix homeserver works by continually polling the + * /sync API endpoint. This module manages that process. It provides a single + * method which initiates a /sync request for an authenticated MatrixAccount. + * + * On completion of the request, any events it returned are dispatched to the + * relevant rooms, and another /sync request is started. + * * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -13,7 +21,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef MATRIX_SYNC_H_ @@ -21,7 +29,7 @@ #include "libmatrix.h" -/* +/** * Start the sync loop for a matrix account. This will repeatedly call * '/sync' to get room information and new events. */ |