mirror of
https://github.com/matrix-construct/construct
synced 2024-12-28 00:14:07 +01:00
112 lines
3.1 KiB
C++
112 lines
3.1 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_NODE_H
|
|
|
|
namespace ircd::m
|
|
{
|
|
struct node;
|
|
|
|
extern room nodes;
|
|
|
|
bool my(const node &);
|
|
bool exists(const node &);
|
|
node create(const node &, const json::members &args = {});
|
|
}
|
|
|
|
/// A node is an entity (lay: a server) participating in the matrix system. The
|
|
/// node may be a peer (ircd::server::peer) which is directly connected or it
|
|
/// may be indirect. The node may be a matrix "origin" or it may be a member
|
|
/// of a cluster perusing under the same origin.
|
|
///
|
|
/// First consider the node_id, which has the sigil ':'. A node which addresses
|
|
/// an origin as a whole has the mxid `::domain.tld` which has an empty
|
|
/// localpart. A node which is concerned with some entity within an origin has
|
|
/// an mxid `:somename:domain.tld`. This is essential for clustered multihoming
|
|
/// of our origin. Note that remote origins are supposed to be opaque, so there
|
|
/// is no real case for addressing a sub-entity other than ours.
|
|
///
|
|
struct ircd::m::node
|
|
{
|
|
struct room;
|
|
struct keys;
|
|
struct mitsein;
|
|
|
|
string_view node_id;
|
|
|
|
node(const string_view &node_id);
|
|
node() = default;
|
|
};
|
|
|
|
/// Every node has its own room acting as a database and log mechanism
|
|
/// for this node. This is similar to the user::room.
|
|
//
|
|
struct ircd::m::node::room
|
|
:m::room
|
|
{
|
|
m::node node;
|
|
id::room::buf room_id;
|
|
|
|
room(const m::node &node);
|
|
room() = default;
|
|
room(const room &) = delete;
|
|
room &operator=(const room &) = delete;
|
|
};
|
|
|
|
/// Interface to federation keys for the node (convenience wrappings of
|
|
/// m::keys).
|
|
struct ircd::m::node::keys
|
|
{
|
|
using ed25519_closure = std::function<void (const ed25519::pk &)>;
|
|
using key_closure = std::function<void (const json::string &)>;
|
|
|
|
m::node node;
|
|
|
|
bool get(const string_view &key_id, const ed25519_closure &) const;
|
|
bool get(const string_view &key_id, const key_closure &) const;
|
|
|
|
keys(const m::node &node)
|
|
:node{node}
|
|
{}
|
|
};
|
|
|
|
/// Interface to the other nodes visible to a node from common rooms.
|
|
struct ircd::m::node::mitsein
|
|
{
|
|
using closure = std::function<bool (const string_view &, const m::room &)>;
|
|
|
|
m::node node;
|
|
|
|
public:
|
|
// All common rooms with node
|
|
bool for_each(const m::node &, const string_view &membership, const closure &) const;
|
|
bool for_each(const m::node &, const closure &) const;
|
|
|
|
// Counting convenience
|
|
size_t count(const m::node &, const string_view &membership = {}) const;
|
|
|
|
// Existential convenience (does `node` and `other` share any common room).
|
|
bool has(const m::node &other, const string_view &membership = {}) const;
|
|
|
|
mitsein(const m::node &node)
|
|
:node{node}
|
|
{}
|
|
};
|
|
|
|
inline
|
|
ircd::m::node::node(const string_view &node_id)
|
|
:node_id
|
|
{
|
|
node_id
|
|
}
|
|
{
|
|
rfc3986::valid_remote(node_id);
|
|
}
|