FileSystemClient.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Niek Linnenbank
 *
 * 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIB_LIBFS_FILESYSTEMCLIENT_H
#define __LIB_LIBFS_FILESYSTEMCLIENT_H
 
#include <FreeNOS/API/ProcessID.h>
#include <Types.h>
#include <Memory.h>
#include "FileSystem.h"
#include "FileSystemMount.h"
 
struct FileSystemMessage;
 
class FileSystemClient
{
  private:
 
    static const Size MaximumFileSystemMounts = 16;
 
  public:
 
    FileSystemClient(const ProcessID pid = ANY);
 
    const String * getCurrentDirectory() const;
 
    void setCurrentDirectory(const String &directory);
 
    void setCurrentDirectory(String *directory);
 
    FileSystem::Result createFile(const char *path,
                                  const FileSystem::FileType type,
                                  const FileSystem::FileModes mode) const;
 
    FileSystem::Result statFile(const char *path,
                                FileSystem::FileStat *st) const;
 
    FileSystem::Result openFile(const char *path,
                                Size & descriptor) const;
 
    FileSystem::Result closeFile(const Size descriptor) const;
 
    FileSystem::Result readFile(const Size descriptor,
                                void *buf,
                                Size *size) const;
 
    FileSystem::Result writeFile(const Size descriptor,
                                 const void *buf,
                                 Size *size) const;
 
    FileSystem::Result deleteFile(const char *path) const;
 
    FileSystem::Result waitFile(const char *filesystemPath,
                                const FileSystem::WaitSet *waitSet,
                                const Size count,
                                const Size msecTimeout) const;
 
    FileSystem::Result mountFileSystem(const char *mountPath) const;
 
    FileSystem::Result waitFileSystem(const char *path) const;
 
    FileSystemMount * getFileSystems(Size &numberOfMounts) const;
 
  private:
 
    FileSystem::Result request(const char *path, FileSystemMessage &msg) const;
 
    FileSystem::Result request(const ProcessID pid, FileSystemMessage &msg) const;
 
    ProcessID findMount(const char *path) const;
 
  private:
 
    static FileSystemMount m_mounts[MaximumFileSystemMounts];
 
    static String *m_currentDirectory;
 
    const ProcessID m_pid;
};
 
#endif /* __LIB_LIBFS_FILESYSTEMCLIENT_H */