mirror of
https://github.com/matrix-construct/construct
synced 2024-11-29 18:22:50 +01:00
modules/client/sync: Split internal sync.h header.
This commit is contained in:
Jason Volk
parent
1177368723
commit
c6a9cf3849
3 changed files with 138 additions and 117 deletions
|
|
@ -34,120 +34,5 @@ namespace ircd::m::sync
|
|||
static resource::response handle_get(client &, const resource::request &);
|
||||
}
|
||||
|
||||
namespace ircd::m::sync::longpoll
|
||||
{
|
||||
struct accepted;
|
||||
|
||||
size_t polling {0};
|
||||
std::deque<accepted> queue;
|
||||
ctx::dock dock;
|
||||
|
||||
static bool handle(data &, const args &, const accepted &, const mutable_buffer &scratch);
|
||||
static bool poll(data &, const args &);
|
||||
static void handle_notify(const m::event &, m::vm::eval &);
|
||||
extern m::hookfn<m::vm::eval &> notified;
|
||||
}
|
||||
|
||||
struct ircd::m::sync::longpoll::accepted
|
||||
:m::event
|
||||
{
|
||||
json::strung strung;
|
||||
std::string client_txnid;
|
||||
event::idx event_idx;
|
||||
|
||||
accepted(const m::vm::eval &eval)
|
||||
:strung
|
||||
{
|
||||
*eval.event_
|
||||
}
|
||||
,client_txnid
|
||||
{
|
||||
eval.copts?
|
||||
eval.copts->client_txnid:
|
||||
string_view{}
|
||||
}
|
||||
,event_idx
|
||||
{
|
||||
eval.sequence
|
||||
}
|
||||
{
|
||||
const json::object object{this->strung};
|
||||
static_cast<m::event &>(*this) = m::event{object};
|
||||
}
|
||||
|
||||
accepted(accepted &&) = default;
|
||||
accepted(const accepted &) = delete;
|
||||
};
|
||||
|
||||
struct ircd::m::sync::args
|
||||
{
|
||||
static conf::item<milliseconds> timeout_max;
|
||||
static conf::item<milliseconds> timeout_min;
|
||||
static conf::item<milliseconds> timeout_default;
|
||||
|
||||
const resource::request &request;
|
||||
|
||||
string_view filter_id
|
||||
{
|
||||
// 6.2.1 The ID of a filter created using the filter API or a filter JSON object
|
||||
// encoded as a string. The server will detect whether it is an ID or a JSON object
|
||||
// by whether the first character is a "{" open brace. Passing the JSON inline is best
|
||||
// suited to one off requests. Creating a filter using the filter API is recommended
|
||||
// for clients that reuse the same filter multiple times, for example in long poll requests.
|
||||
request.query["filter"]
|
||||
};
|
||||
|
||||
uint64_t since
|
||||
{
|
||||
// 6.2.1 A point in time to continue a sync from.
|
||||
request.query.get<uint64_t>("since", 0)
|
||||
};
|
||||
|
||||
uint64_t next_batch
|
||||
{
|
||||
// [experimental] A upper bound to stop this sync at. This is used in
|
||||
// conjunction with `since` to provide a stable window of results. If
|
||||
// not specified the sync range is everything after `since`. NOTE that
|
||||
// this DOES NOT guarantee true idempotency in all cases and for all
|
||||
// time. But that would be nice. Many sync modules do not support this
|
||||
// because the results of repeated calls for range may become empty
|
||||
// after a while.
|
||||
request.query.get<uint64_t>("next_batch", -1)
|
||||
};
|
||||
|
||||
steady_point timesout{[this]
|
||||
{
|
||||
// 6.2.1 The maximum time to poll in milliseconds before returning this request.
|
||||
auto ret(request.query.get("timeout", milliseconds(timeout_default)));
|
||||
ret = std::min(ret, milliseconds(timeout_max));
|
||||
ret = std::max(ret, milliseconds(timeout_min));
|
||||
return now<steady_point>() + ret;
|
||||
}()};
|
||||
|
||||
bool full_state
|
||||
{
|
||||
// 6.2.1 Controls whether to include the full state for all rooms the user is a member of.
|
||||
// If this is set to true, then all state events will be returned, even if since is non-empty.
|
||||
// The timeline will still be limited by the since parameter. In this case, the timeout
|
||||
// parameter will be ignored and the query will return immediately, possibly with an
|
||||
// empty timeline. If false, and since is non-empty, only state which has changed since
|
||||
// the point indicated by since will be returned. By default, this is false.
|
||||
request.query.get("full_state", false)
|
||||
};
|
||||
|
||||
bool set_presence
|
||||
{
|
||||
// 6.2.1 Controls whether the client is automatically marked as online by polling this API.
|
||||
// If this parameter is omitted then the client is automatically marked as online when it
|
||||
// uses this API. Otherwise if the parameter is set to "offline" then the client is not
|
||||
// marked as being online when it uses this API. One of: ["offline"]
|
||||
request.query.get("set_presence", true)
|
||||
};
|
||||
|
||||
bool phased
|
||||
{
|
||||
request.query.get("phased", true)
|
||||
};
|
||||
|
||||
args(const resource::request &request);
|
||||
};
|
||||
#include "sync/longpoll.h"
|
||||
#include "sync/args.h"
|
||||
|
|
|
|||
82
modules/client/sync/args.h
Normal file
82
modules/client/sync/args.h
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
// Matrix Construct
|
||||
//
|
||||
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
||||
// Copyright (C) 2016-2019 Jason Volk <jason@zemos.net>
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice is present in all copies. The
|
||||
// full license for this software is available in the LICENSE file.
|
||||
|
||||
struct ircd::m::sync::args
|
||||
{
|
||||
static conf::item<milliseconds> timeout_max;
|
||||
static conf::item<milliseconds> timeout_min;
|
||||
static conf::item<milliseconds> timeout_default;
|
||||
|
||||
const resource::request &request;
|
||||
|
||||
string_view filter_id
|
||||
{
|
||||
// 6.2.1 The ID of a filter created using the filter API or a filter JSON object
|
||||
// encoded as a string. The server will detect whether it is an ID or a JSON object
|
||||
// by whether the first character is a "{" open brace. Passing the JSON inline is best
|
||||
// suited to one off requests. Creating a filter using the filter API is recommended
|
||||
// for clients that reuse the same filter multiple times, for example in long poll requests.
|
||||
request.query["filter"]
|
||||
};
|
||||
|
||||
uint64_t since
|
||||
{
|
||||
// 6.2.1 A point in time to continue a sync from.
|
||||
request.query.get<uint64_t>("since", 0)
|
||||
};
|
||||
|
||||
uint64_t next_batch
|
||||
{
|
||||
// [experimental] A upper bound to stop this sync at. This is used in
|
||||
// conjunction with `since` to provide a stable window of results. If
|
||||
// not specified the sync range is everything after `since`. NOTE that
|
||||
// this DOES NOT guarantee true idempotency in all cases and for all
|
||||
// time. But that would be nice. Many sync modules do not support this
|
||||
// because the results of repeated calls for range may become empty
|
||||
// after a while.
|
||||
request.query.get<uint64_t>("next_batch", -1)
|
||||
};
|
||||
|
||||
steady_point timesout{[this]
|
||||
{
|
||||
// 6.2.1 The maximum time to poll in milliseconds before returning this request.
|
||||
auto ret(request.query.get("timeout", milliseconds(timeout_default)));
|
||||
ret = std::min(ret, milliseconds(timeout_max));
|
||||
ret = std::max(ret, milliseconds(timeout_min));
|
||||
return now<steady_point>() + ret;
|
||||
}()};
|
||||
|
||||
bool full_state
|
||||
{
|
||||
// 6.2.1 Controls whether to include the full state for all rooms the user is a member of.
|
||||
// If this is set to true, then all state events will be returned, even if since is non-empty.
|
||||
// The timeline will still be limited by the since parameter. In this case, the timeout
|
||||
// parameter will be ignored and the query will return immediately, possibly with an
|
||||
// empty timeline. If false, and since is non-empty, only state which has changed since
|
||||
// the point indicated by since will be returned. By default, this is false.
|
||||
request.query.get("full_state", false)
|
||||
};
|
||||
|
||||
bool set_presence
|
||||
{
|
||||
// 6.2.1 Controls whether the client is automatically marked as online by polling this API.
|
||||
// If this parameter is omitted then the client is automatically marked as online when it
|
||||
// uses this API. Otherwise if the parameter is set to "offline" then the client is not
|
||||
// marked as being online when it uses this API. One of: ["offline"]
|
||||
request.query.get("set_presence", true)
|
||||
};
|
||||
|
||||
bool phased
|
||||
{
|
||||
request.query.get("phased", true)
|
||||
};
|
||||
|
||||
args(const resource::request &request);
|
||||
};
|
||||
54
modules/client/sync/longpoll.h
Normal file
54
modules/client/sync/longpoll.h
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
// Matrix Construct
|
||||
//
|
||||
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
||||
// Copyright (C) 2016-2019 Jason Volk <jason@zemos.net>
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice is present in all copies. The
|
||||
// full license for this software is available in the LICENSE file.
|
||||
|
||||
namespace ircd::m::sync::longpoll
|
||||
{
|
||||
struct accepted;
|
||||
|
||||
size_t polling {0};
|
||||
std::deque<accepted> queue;
|
||||
ctx::dock dock;
|
||||
|
||||
static bool handle(data &, const args &, const accepted &, const mutable_buffer &scratch);
|
||||
static bool poll(data &, const args &);
|
||||
static void handle_notify(const m::event &, m::vm::eval &);
|
||||
extern m::hookfn<m::vm::eval &> notified;
|
||||
}
|
||||
|
||||
struct ircd::m::sync::longpoll::accepted
|
||||
:m::event
|
||||
{
|
||||
json::strung strung;
|
||||
std::string client_txnid;
|
||||
event::idx event_idx;
|
||||
|
||||
accepted(const m::vm::eval &eval)
|
||||
:strung
|
||||
{
|
||||
*eval.event_
|
||||
}
|
||||
,client_txnid
|
||||
{
|
||||
eval.copts?
|
||||
eval.copts->client_txnid:
|
||||
string_view{}
|
||||
}
|
||||
,event_idx
|
||||
{
|
||||
eval.sequence
|
||||
}
|
||||
{
|
||||
const json::object object{this->strung};
|
||||
static_cast<m::event &>(*this) = m::event{object};
|
||||
}
|
||||
|
||||
accepted(accepted &&) = default;
|
||||
accepted(const accepted &) = delete;
|
||||
};
|
||||
Loading…
Reference in a new issue