0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-07-13 22:18:35 +02:00
construct/include/ircd/m/event/fetch.h

73 lines
2.4 KiB
C++

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 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.
#pragma once
#define HAVE_IRCD_M_EVENT_FETCH_H
struct ircd::m::event::fetch
:event
{
struct opts;
using keys = event::keys;
using view_closure = std::function<void (const string_view &)>;
static const opts default_opts;
std::array<db::cell, event::size()> cell;
db::cell _json;
db::row row;
bool valid;
public:
fetch(const idx &, std::nothrow_t, const opts *const & = nullptr);
fetch(const idx &, const opts *const & = nullptr);
fetch(const id &, std::nothrow_t, const opts *const & = nullptr);
fetch(const id &, const opts *const & = nullptr);
fetch(const opts *const & = nullptr);
static bool event_id(const idx &, std::nothrow_t, const id::closure &);
static void event_id(const idx &, const id::closure &);
};
namespace ircd::m
{
bool seek(event::fetch &, const event::idx &, std::nothrow_t, const event::fetch::opts *const & = nullptr);
void seek(event::fetch &, const event::idx &, const event::fetch::opts *const & = nullptr);
bool seek(event::fetch &, const event::id &, std::nothrow_t, const event::fetch::opts *const & = nullptr);
void seek(event::fetch &, const event::id &, const event::fetch::opts *const & = nullptr);
}
struct ircd::m::event::fetch::opts
{
/// Event property selector
event::keys keys;
/// Database get options passthru
db::gopts gopts;
/// Whether to allowing querying the event_json to populate the event if
/// it would be more efficient based on the keys being sought. Ex. If all
/// keys are being sought then we can make a single query to event_json
/// rather than a concurrent row query. This is enabled by default.
bool query_json_maybe {true};
/// Whether to force only querying for event_json to populate the event,
/// regardless of what keys are sought in the property selector. This is
/// not enabled by default.
bool query_json_only {false};
opts(const event::keys &, const db::gopts & = {});
opts(const event::keys::selection &, const db::gopts & = {});
opts(const db::gopts &, const event::keys::selection & = {});
opts() = default;
};