L4Re/departure

Annotated libfsserver/include/fsserver/directory_resource.h

207:5e038d939c95
2021-09-27 Paul Boddie Added the notification interface to directory resources.
paul@202 1
/*
paul@202 2
 * A resource offering support for directory operations.
paul@202 3
 *
paul@202 4
 * Copyright (C) 2021 Paul Boddie <paul@boddie.org.uk>
paul@202 5
 *
paul@202 6
 * This program is free software; you can redistribute it and/or
paul@202 7
 * modify it under the terms of the GNU General Public License as
paul@202 8
 * published by the Free Software Foundation; either version 2 of
paul@202 9
 * the License, or (at your option) any later version.
paul@202 10
 *
paul@202 11
 * This program is distributed in the hope that it will be useful,
paul@202 12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
paul@202 13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
paul@202 14
 * GNU General Public License for more details.
paul@202 15
 *
paul@202 16
 * You should have received a copy of the GNU General Public License
paul@202 17
 * along with this program; if not, write to the Free Software
paul@202 18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
paul@202 19
 * Boston, MA  02110-1301, USA
paul@202 20
 */
paul@202 21
paul@202 22
#pragma once
paul@202 23
paul@202 24
#include <fsserver/directory_object_interface.h>
paul@202 25
#include <fsserver/directory_provider.h>
paul@202 26
#include <fsserver/file_registry.h>
paul@202 27
#include <fsserver/resource.h>
paul@202 28
paul@202 29
paul@202 30
paul@207 31
/* Support for providing access to directories. */
paul@202 32
paul@202 33
class DirectoryResource : public Resource, public DirectoryObject
paul@202 34
{
paul@202 35
protected:
paul@202 36
    FileRegistry *_registry;
paul@202 37
    DirectoryProvider *_provider;
paul@202 38
paul@207 39
    /* Notification endpoint for event subscription. */
paul@207 40
paul@207 41
    unsigned int _endpoint;
paul@207 42
paul@202 43
public:
paul@202 44
    fileid_t fileid;
paul@202 45
paul@202 46
    DirectoryResource(fileid_t fileid, DirectoryProvider *provider,
paul@202 47
                      FileRegistry *registry);
paul@202 48
paul@202 49
    virtual ~DirectoryResource();
paul@202 50
paul@202 51
    virtual void close();
paul@202 52
paul@202 53
    /* Server details. */
paul@202 54
paul@202 55
    int expected_items();
paul@202 56
paul@202 57
    ipc_server_handler_type handler();
paul@202 58
paul@202 59
    void *interface()
paul@202 60
    { return static_cast<DirectoryObject *>(this); }
paul@202 61
paul@202 62
    /* Directory reading methods. */
paul@202 63
paul@202 64
    virtual long opendir(offset_t *size, l4_cap_idx_t *cap,
paul@202 65
                         object_flags_t *object_flags);
paul@207 66
paul@207 67
    /* Notification methods. */
paul@207 68
paul@207 69
    virtual long subscribe(l4_cap_idx_t endpoint, notify_flags_t flags);
paul@207 70
paul@207 71
    virtual long unsubscribe(l4_cap_idx_t endpoint);
paul@202 72
};
paul@202 73
paul@202 74
// vim: tabstop=4 expandtab shiftwidth=4