Documentation
¶
Overview ¶
Package cephfs contains a set of wrappers around Ceph's libcephfs API.
Index ¶
- type CephFSError
- type DirEntry
- type Directory
- type Inode
- type MountInfo
- func (mount *MountInfo) ChangeDir(path string) error
- func (mount *MountInfo) Chmod(path string, mode uint32) error
- func (mount *MountInfo) Chown(path string, user uint32, group uint32) error
- func (mount *MountInfo) CurrentDir() string
- func (mount *MountInfo) GetConfigOption(option string) (string, error)
- func (mount *MountInfo) GetFsCid() (int64, error)
- func (mount *MountInfo) IsMounted() bool
- func (mount *MountInfo) MakeDir(path string, mode uint32) error
- func (mount *MountInfo) MdsCommand(mdsSpec string, args [][]byte) ([]byte, string, error)
- func (mount *MountInfo) MdsCommandWithInputBuffer(mdsSpec string, args [][]byte, inputBuffer []byte) ([]byte, string, error)
- func (mount *MountInfo) Mount() error
- func (mount *MountInfo) MountWithRoot(root string) error
- func (mount *MountInfo) OpenDir(path string) (*Directory, error)
- func (mount *MountInfo) ReadDefaultConfigFile() error
- func (mount *MountInfo) Release() error
- func (mount *MountInfo) RemoveDir(path string) error
- func (mount *MountInfo) SetConfigOption(option, value string) error
- func (mount *MountInfo) SyncFs() error
- func (mount *MountInfo) Unmount() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CephFSError ¶
type CephFSError int
CephFSError represents an error condition returned from the CephFS APIs.
func (CephFSError) Error ¶
func (e CephFSError) Error() string
Error returns the error string for the CephFSError type.
type DirEntry ¶ added in v0.3.0
type DirEntry struct {
// contains filtered or unexported fields
}
DirEntry represents an entry within a directory.
type Directory ¶ added in v0.3.0
type Directory struct {
// contains filtered or unexported fields
}
Directory represents an open directory handle.
func (*Directory) Close ¶ added in v0.3.0
Close the open directory handle.
Implements:
int ceph_closedir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);
func (*Directory) ReadDir ¶ added in v0.3.0
ReadDir reads a single directory entry from the open Directory. A nil DirEntry pointer will be returned when the Directory stream has been exhausted.
Implements:
int ceph_readdir_r(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp, struct dirent *de);
type MountInfo ¶
type MountInfo struct {
// contains filtered or unexported fields
}
MountInfo exports ceph's ceph_mount_info from libcephfs.cc
func CreateFromRados ¶
CreateFromRados creates a mount handle using an existing rados cluster connection.
Implements:
int ceph_create_from_rados(struct ceph_mount_info **cmount, rados_t cluster);
func CreateMount ¶
CreateMount creates a mount handle for interacting with Ceph.
func CreateMountWithId ¶
CreateMountWithId creates a mount handle for interacting with Ceph. The caller can specify a unique id that will identify this client.
func (*MountInfo) CurrentDir ¶
CurrentDir gets the current working directory.
func (*MountInfo) GetConfigOption ¶ added in v0.3.0
GetConfigOption returns the value of the Ceph configuration option identified by the given name.
Implements:
int ceph_conf_get(struct ceph_mount_info *cmount, const char *option, char *buf, size_t len);
func (*MountInfo) GetFsCid ¶ added in v0.3.0
GetFsCid returns the cluster ID for a mounted ceph file system. If the object does not refer to a mounted file system, an error will be returned.
Note:
Only supported in Ceph Nautilus and newer.
Implements:
int64_t ceph_get_fs_cid(struct ceph_mount_info *cmount);
func (*MountInfo) MdsCommand ¶
MdsCommand sends commands to the specified MDS.
func (*MountInfo) MdsCommandWithInputBuffer ¶
func (mount *MountInfo) MdsCommandWithInputBuffer(mdsSpec string, args [][]byte, inputBuffer []byte) ([]byte, string, error)
MdsCommandWithInputBuffer sends commands to the specified MDS, with an input buffer.
func (*MountInfo) Mount ¶
Mount the file system, establishing a connection capable of I/O.
Implements:
int ceph_mount(struct ceph_mount_info *cmount, const char *root);
func (*MountInfo) MountWithRoot ¶ added in v0.3.0
MountWithRoot mounts the file system using the path provided for the root of the mount. This establishes a connection capable of I/O.
Implements:
int ceph_mount(struct ceph_mount_info *cmount, const char *root);
func (*MountInfo) OpenDir ¶ added in v0.3.0
OpenDir returns a new Directory handle open for I/O.
Implements:
int ceph_opendir(struct ceph_mount_info *cmount, const char *name, struct ceph_dir_result **dirpp);
func (*MountInfo) ReadDefaultConfigFile ¶
ReadDefaultConfigFile loads the ceph configuration from the specified config file.
func (*MountInfo) Release ¶
Release destroys the mount handle.
Implements:
int ceph_release(struct ceph_mount_info *cmount);
func (*MountInfo) SetConfigOption ¶ added in v0.3.0
SetConfigOption sets the value of the configuration option identified by the given name.
Implements:
int ceph_conf_set(struct ceph_mount_info *cmount, const char *option, const char *value);
Source Files