Documentation
¶
Index ¶
- func IsFileHandleNotFoundError(err error) bool
- func IsIrodsFsClientInstanceNotFoundError(err error) bool
- func IsSessionNotFoundError(err error) bool
- func MakeIRODSFSClientInstanceID(account *api.Account) string
- type FileHandleNotFoundError
- type IRODSFSClientInstance
- func (instance *IRODSFSClientInstance) AddPoolSession(poolSession *PoolSession)
- func (instance *IRODSFSClientInstance) GetFSClient() irodsfs_common_irods.IRODSFSClient
- func (instance *IRODSFSClientInstance) GetID() string
- func (instance *IRODSFSClientInstance) GetPoolSessions() int
- func (instance *IRODSFSClientInstance) Release()
- func (instance *IRODSFSClientInstance) ReleaseIfNoPoolSession() bool
- func (instance *IRODSFSClientInstance) RemovePoolSession(poolSessionID string)
- type IrodsFsClientInstanceNotFoundError
- type PoolFileHandle
- func (handle *PoolFileHandle) AddFileHandlesForPrefetching(irodsFsFileHandles []irodsfs_common_irods.IRODSFSFileHandle)
- func (handle *PoolFileHandle) Flush() error
- func (handle *PoolFileHandle) GetAvailable(offset int64) int64
- func (handle *PoolFileHandle) GetEntryPath() string
- func (handle *PoolFileHandle) GetID() string
- func (handle *PoolFileHandle) GetOffset() int64
- func (handle *PoolFileHandle) GetOpenMode() irodsclient_types.FileOpenMode
- func (handle *PoolFileHandle) ReadAt(buffer []byte, offset int64) (int, error)
- func (handle *PoolFileHandle) Release() error
- func (handle *PoolFileHandle) Truncate(size int64) error
- func (handle *PoolFileHandle) WriteAt(data []byte, offset int64) (int, error)
- type PoolServer
- func (server *PoolServer) Close(context context.Context, request *api.CloseRequest) (*api.Empty, error)
- func (server *PoolServer) CollectMetrics() irodsclient_metrics.IRODSMetrics
- func (server *PoolServer) CollectPrometheusMetrics()
- func (server *PoolServer) CreateFile(context context.Context, request *api.CreateFileRequest) (*api.CreateFileResponse, error)
- func (server *PoolServer) ExistsDir(context context.Context, request *api.ExistsDirRequest) (*api.ExistsDirResponse, error)
- func (server *PoolServer) ExistsFile(context context.Context, request *api.ExistsFileRequest) (*api.ExistsFileResponse, error)
- func (server *PoolServer) Flush(context context.Context, request *api.FlushRequest) (*api.Empty, error)
- func (server *PoolServer) GetIRODSConnections() int
- func (server *PoolServer) GetIRODSFSClientInstanceCount() int
- func (server *PoolServer) GetOffset(context context.Context, request *api.GetOffsetRequest) (*api.GetOffsetResponse, error)
- func (server *PoolServer) GetPoolSessions() int
- func (server *PoolServer) GetXattr(context context.Context, request *api.GetXattrRequest) (*api.GetXattrResponse, error)
- func (server *PoolServer) List(context context.Context, request *api.ListRequest) (*api.ListResponse, error)
- func (server *PoolServer) ListACLsForEntries(context context.Context, request *api.ListACLsForEntriesRequest) (*api.ListACLsForEntriesResponse, error)
- func (server *PoolServer) ListDirACLs(context context.Context, request *api.ListDirACLsRequest) (*api.ListDirACLsResponse, error)
- func (server *PoolServer) ListFileACLs(context context.Context, request *api.ListFileACLsRequest) (*api.ListFileACLsResponse, error)
- func (server *PoolServer) ListUserGroups(context context.Context, request *api.ListUserGroupsRequest) (*api.ListUserGroupsResponse, error)
- func (server *PoolServer) ListXattr(context context.Context, request *api.ListXattrRequest) (*api.ListXattrResponse, error)
- func (server *PoolServer) Login(context context.Context, request *api.LoginRequest) (*api.LoginResponse, error)
- func (server *PoolServer) Logout(context context.Context, request *api.LogoutRequest) (*api.Empty, error)
- func (server *PoolServer) LogoutAll()
- func (server *PoolServer) MakeDir(context context.Context, request *api.MakeDirRequest) (*api.Empty, error)
- func (server *PoolServer) OpenFile(context context.Context, request *api.OpenFileRequest) (*api.OpenFileResponse, error)
- func (server *PoolServer) ReadAt(context context.Context, request *api.ReadAtRequest) (*api.ReadAtResponse, error)
- func (server *PoolServer) Release()
- func (server *PoolServer) RemoveDir(context context.Context, request *api.RemoveDirRequest) (*api.Empty, error)
- func (server *PoolServer) RemoveFile(context context.Context, request *api.RemoveFileRequest) (*api.Empty, error)
- func (server *PoolServer) RemoveXattr(context context.Context, request *api.RemoveXattrRequest) (*api.Empty, error)
- func (server *PoolServer) RenameDirToDir(context context.Context, request *api.RenameDirToDirRequest) (*api.Empty, error)
- func (server *PoolServer) RenameFileToFile(context context.Context, request *api.RenameFileToFileRequest) (*api.Empty, error)
- func (server *PoolServer) SetXattr(context context.Context, request *api.SetXattrRequest) (*api.Empty, error)
- func (server *PoolServer) Stat(context context.Context, request *api.StatRequest) (*api.StatResponse, error)
- func (server *PoolServer) Truncate(context context.Context, request *api.TruncateRequest) (*api.Empty, error)
- func (server *PoolServer) TruncateFile(context context.Context, request *api.TruncateFileRequest) (*api.Empty, error)
- func (server *PoolServer) WriteAt(context context.Context, request *api.WriteAtRequest) (*api.Empty, error)
- type PoolServerConfig
- type PoolService
- type PoolServiceStatHandler
- func (handler *PoolServiceStatHandler) HandleConn(c context.Context, s stats.ConnStats)
- func (handler *PoolServiceStatHandler) HandleRPC(context.Context, stats.RPCStats)
- func (handler *PoolServiceStatHandler) TagConn(context.Context, *stats.ConnTagInfo) context.Context
- func (handler *PoolServiceStatHandler) TagRPC(context.Context, *stats.RPCTagInfo) context.Context
- type PoolSession
- func (session *PoolSession) AddPoolFileHandle(poolFileHandle *PoolFileHandle)
- func (session *PoolSession) GetID() string
- func (session *PoolSession) GetIRODSFSClientInstanceID() string
- func (session *PoolSession) GetPoolClientID() string
- func (session *PoolSession) GetPoolFileHandle(poolFileHandleID string) *PoolFileHandle
- func (session *PoolSession) Release()
- func (session *PoolSession) RemovePoolFileHandle(poolFileHandleID string)
- func (session *PoolSession) SetIRODSFSClientInstanceID(irodsFsClientInstanceID string)
- func (session *PoolSession) UpdateLastAccessTime()
- type SessionNotFoundError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsFileHandleNotFoundError ¶ added in v0.6.0
IsFileHandleNotFoundError evaluates if the given error is FileHandleNotFoundError
func IsIrodsFsClientInstanceNotFoundError ¶ added in v0.6.0
IsIrodsFsClientInstanceNotFoundError evaluates if the given error is IrodsFsClientInstanceNotFoundError
func IsSessionNotFoundError ¶ added in v0.6.0
IsSessionNotFoundError evaluates if the given error is SessionNotFoundError
func MakeIRODSFSClientInstanceID ¶ added in v0.5.0
MakeIRODSFSClientInstanceID creates an iRODSFSClientInstance ID
Types ¶
type FileHandleNotFoundError ¶ added in v0.6.0
type FileHandleNotFoundError struct {
// contains filtered or unexported fields
}
FileHandleNotFoundError ...
func NewFileHandleNotFoundError ¶ added in v0.6.0
func NewFileHandleNotFoundError(message string) *FileHandleNotFoundError
NewFileHandleNotFoundError creates FileHandleNotFoundError struct
func NewFileHandleNotFoundErrorf ¶ added in v0.6.0
func NewFileHandleNotFoundErrorf(format string, v ...interface{}) *FileHandleNotFoundError
NewFileHandleNotFoundErrorf creates FileHandleNotFoundError struct
func (*FileHandleNotFoundError) Error ¶ added in v0.6.0
func (e *FileHandleNotFoundError) Error() string
type IRODSFSClientInstance ¶ added in v0.5.0
type IRODSFSClientInstance struct {
// contains filtered or unexported fields
}
IRODSFSClientInstance is a struct for iRODS FS Client Instance
func NewIRODSFSClientInstance ¶ added in v0.5.0
func NewIRODSFSClientInstance(irodsFsClientInstanceID string, account *api.Account, applicationName string, cacheTimeoutSettings []commons.MetadataCacheTimeoutSetting) (*IRODSFSClientInstance, error)
NewIRODSFSClientInstance creates a new IRODSFSClientInstance
func (*IRODSFSClientInstance) AddPoolSession ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) AddPoolSession(poolSession *PoolSession)
func (*IRODSFSClientInstance) GetFSClient ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) GetFSClient() irodsfs_common_irods.IRODSFSClient
func (*IRODSFSClientInstance) GetID ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) GetID() string
func (*IRODSFSClientInstance) GetPoolSessions ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) GetPoolSessions() int
func (*IRODSFSClientInstance) Release ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) Release()
func (*IRODSFSClientInstance) ReleaseIfNoPoolSession ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) ReleaseIfNoPoolSession() bool
func (*IRODSFSClientInstance) RemovePoolSession ¶ added in v0.5.0
func (instance *IRODSFSClientInstance) RemovePoolSession(poolSessionID string)
type IrodsFsClientInstanceNotFoundError ¶ added in v0.6.0
type IrodsFsClientInstanceNotFoundError struct {
// contains filtered or unexported fields
}
IrodsFsClientInstanceNotFoundError ...
func NewIrodsFsClientInstanceNotFoundError ¶ added in v0.6.0
func NewIrodsFsClientInstanceNotFoundError(message string) *IrodsFsClientInstanceNotFoundError
NewIrodsFsClientInstanceNotFoundError creates IrodsFsClientInstanceNotFoundError struct
func NewIrodsFsClientInstanceNotFoundErrorf ¶ added in v0.6.0
func NewIrodsFsClientInstanceNotFoundErrorf(format string, v ...interface{}) *IrodsFsClientInstanceNotFoundError
NewIrodsFsClientInstanceNotFoundErrorf creates IrodsFsClientInstanceNotFoundError struct
func (*IrodsFsClientInstanceNotFoundError) Error ¶ added in v0.6.0
func (e *IrodsFsClientInstanceNotFoundError) Error() string
type PoolFileHandle ¶ added in v0.5.0
type PoolFileHandle struct {
// contains filtered or unexported fields
}
PoolFileHandle is a file handle managed by iRODSFS-Pool
func NewPoolFileHandle ¶ added in v0.5.0
func NewPoolFileHandle(poolServer *PoolServer, poolSessionID string, irodsFsClientInstanceID string, irodsFsFileHandle irodsfs_common_irods.IRODSFSFileHandle, irodsFsFileHandlesForPrefetching []irodsfs_common_irods.IRODSFSFileHandle) (*PoolFileHandle, error)
NewPoolFileHandle creates a new pool file handle
func (*PoolFileHandle) AddFileHandlesForPrefetching ¶ added in v0.5.4
func (handle *PoolFileHandle) AddFileHandlesForPrefetching(irodsFsFileHandles []irodsfs_common_irods.IRODSFSFileHandle)
func (*PoolFileHandle) Flush ¶ added in v0.5.0
func (handle *PoolFileHandle) Flush() error
func (*PoolFileHandle) GetAvailable ¶ added in v0.5.4
func (handle *PoolFileHandle) GetAvailable(offset int64) int64
func (*PoolFileHandle) GetEntryPath ¶ added in v0.5.0
func (handle *PoolFileHandle) GetEntryPath() string
func (*PoolFileHandle) GetID ¶ added in v0.5.0
func (handle *PoolFileHandle) GetID() string
func (*PoolFileHandle) GetOffset ¶ added in v0.5.0
func (handle *PoolFileHandle) GetOffset() int64
func (*PoolFileHandle) GetOpenMode ¶ added in v0.5.0
func (handle *PoolFileHandle) GetOpenMode() irodsclient_types.FileOpenMode
func (*PoolFileHandle) ReadAt ¶ added in v0.5.0
func (handle *PoolFileHandle) ReadAt(buffer []byte, offset int64) (int, error)
func (*PoolFileHandle) Release ¶ added in v0.5.0
func (handle *PoolFileHandle) Release() error
func (*PoolFileHandle) Truncate ¶ added in v0.5.0
func (handle *PoolFileHandle) Truncate(size int64) error
type PoolServer ¶ added in v0.5.0
type PoolServer struct { api.UnimplementedPoolAPIServer // contains filtered or unexported fields }
PoolServer is a struct for PoolServer
func NewPoolServer ¶ added in v0.5.0
func NewPoolServer(config *PoolServerConfig) (*PoolServer, error)
func (*PoolServer) Close ¶ added in v0.5.0
func (server *PoolServer) Close(context context.Context, request *api.CloseRequest) (*api.Empty, error)
func (*PoolServer) CollectMetrics ¶ added in v0.5.12
func (server *PoolServer) CollectMetrics() irodsclient_metrics.IRODSMetrics
func (*PoolServer) CollectPrometheusMetrics ¶ added in v0.5.12
func (server *PoolServer) CollectPrometheusMetrics()
func (*PoolServer) CreateFile ¶ added in v0.5.0
func (server *PoolServer) CreateFile(context context.Context, request *api.CreateFileRequest) (*api.CreateFileResponse, error)
func (*PoolServer) ExistsDir ¶ added in v0.5.0
func (server *PoolServer) ExistsDir(context context.Context, request *api.ExistsDirRequest) (*api.ExistsDirResponse, error)
func (*PoolServer) ExistsFile ¶ added in v0.5.0
func (server *PoolServer) ExistsFile(context context.Context, request *api.ExistsFileRequest) (*api.ExistsFileResponse, error)
func (*PoolServer) Flush ¶ added in v0.5.0
func (server *PoolServer) Flush(context context.Context, request *api.FlushRequest) (*api.Empty, error)
func (*PoolServer) GetIRODSConnections ¶ added in v0.5.0
func (server *PoolServer) GetIRODSConnections() int
func (*PoolServer) GetIRODSFSClientInstanceCount ¶ added in v0.5.0
func (server *PoolServer) GetIRODSFSClientInstanceCount() int
func (*PoolServer) GetOffset ¶ added in v0.5.0
func (server *PoolServer) GetOffset(context context.Context, request *api.GetOffsetRequest) (*api.GetOffsetResponse, error)
func (*PoolServer) GetPoolSessions ¶ added in v0.5.0
func (server *PoolServer) GetPoolSessions() int
func (*PoolServer) GetXattr ¶ added in v0.6.0
func (server *PoolServer) GetXattr(context context.Context, request *api.GetXattrRequest) (*api.GetXattrResponse, error)
func (*PoolServer) List ¶ added in v0.5.0
func (server *PoolServer) List(context context.Context, request *api.ListRequest) (*api.ListResponse, error)
func (*PoolServer) ListACLsForEntries ¶ added in v0.5.8
func (server *PoolServer) ListACLsForEntries(context context.Context, request *api.ListACLsForEntriesRequest) (*api.ListACLsForEntriesResponse, error)
func (*PoolServer) ListDirACLs ¶ added in v0.5.0
func (server *PoolServer) ListDirACLs(context context.Context, request *api.ListDirACLsRequest) (*api.ListDirACLsResponse, error)
func (*PoolServer) ListFileACLs ¶ added in v0.5.0
func (server *PoolServer) ListFileACLs(context context.Context, request *api.ListFileACLsRequest) (*api.ListFileACLsResponse, error)
func (*PoolServer) ListUserGroups ¶ added in v0.5.0
func (server *PoolServer) ListUserGroups(context context.Context, request *api.ListUserGroupsRequest) (*api.ListUserGroupsResponse, error)
func (*PoolServer) ListXattr ¶ added in v0.6.0
func (server *PoolServer) ListXattr(context context.Context, request *api.ListXattrRequest) (*api.ListXattrResponse, error)
func (*PoolServer) Login ¶ added in v0.5.0
func (server *PoolServer) Login(context context.Context, request *api.LoginRequest) (*api.LoginResponse, error)
func (*PoolServer) Logout ¶ added in v0.5.0
func (server *PoolServer) Logout(context context.Context, request *api.LogoutRequest) (*api.Empty, error)
func (*PoolServer) LogoutAll ¶ added in v0.5.0
func (server *PoolServer) LogoutAll()
func (*PoolServer) MakeDir ¶ added in v0.5.0
func (server *PoolServer) MakeDir(context context.Context, request *api.MakeDirRequest) (*api.Empty, error)
func (*PoolServer) OpenFile ¶ added in v0.5.0
func (server *PoolServer) OpenFile(context context.Context, request *api.OpenFileRequest) (*api.OpenFileResponse, error)
func (*PoolServer) ReadAt ¶ added in v0.5.0
func (server *PoolServer) ReadAt(context context.Context, request *api.ReadAtRequest) (*api.ReadAtResponse, error)
func (*PoolServer) Release ¶ added in v0.5.0
func (server *PoolServer) Release()
func (*PoolServer) RemoveDir ¶ added in v0.5.0
func (server *PoolServer) RemoveDir(context context.Context, request *api.RemoveDirRequest) (*api.Empty, error)
func (*PoolServer) RemoveFile ¶ added in v0.5.0
func (server *PoolServer) RemoveFile(context context.Context, request *api.RemoveFileRequest) (*api.Empty, error)
func (*PoolServer) RemoveXattr ¶ added in v0.6.0
func (server *PoolServer) RemoveXattr(context context.Context, request *api.RemoveXattrRequest) (*api.Empty, error)
func (*PoolServer) RenameDirToDir ¶ added in v0.5.0
func (server *PoolServer) RenameDirToDir(context context.Context, request *api.RenameDirToDirRequest) (*api.Empty, error)
func (*PoolServer) RenameFileToFile ¶ added in v0.5.0
func (server *PoolServer) RenameFileToFile(context context.Context, request *api.RenameFileToFileRequest) (*api.Empty, error)
func (*PoolServer) SetXattr ¶ added in v0.6.0
func (server *PoolServer) SetXattr(context context.Context, request *api.SetXattrRequest) (*api.Empty, error)
func (*PoolServer) Stat ¶ added in v0.5.0
func (server *PoolServer) Stat(context context.Context, request *api.StatRequest) (*api.StatResponse, error)
func (*PoolServer) Truncate ¶ added in v0.5.0
func (server *PoolServer) Truncate(context context.Context, request *api.TruncateRequest) (*api.Empty, error)
func (*PoolServer) TruncateFile ¶ added in v0.5.0
func (server *PoolServer) TruncateFile(context context.Context, request *api.TruncateFileRequest) (*api.Empty, error)
func (*PoolServer) WriteAt ¶ added in v0.5.0
func (server *PoolServer) WriteAt(context context.Context, request *api.WriteAtRequest) (*api.Empty, error)
type PoolServerConfig ¶ added in v0.5.0
type PoolServerConfig struct { CacheSizeMax int64 CacheRootPath string CacheTimeoutSettings []commons.MetadataCacheTimeoutSetting TempRootPath string }
PoolServerConfig is a configuration for Server
type PoolService ¶
type PoolService struct {
// contains filtered or unexported fields
}
PoolService is a service object
func NewPoolService ¶
func NewPoolService(config *commons.Config) (*PoolService, error)
NewPoolService creates a new pool service
func (*PoolService) Release ¶ added in v0.6.0
func (svc *PoolService) Release()
Release releases the service
type PoolServiceStatHandler ¶
type PoolServiceStatHandler struct {
// contains filtered or unexported fields
}
func (*PoolServiceStatHandler) HandleConn ¶
func (handler *PoolServiceStatHandler) HandleConn(c context.Context, s stats.ConnStats)
HandleConn processes the Conn stats.
func (*PoolServiceStatHandler) HandleRPC ¶
func (handler *PoolServiceStatHandler) HandleRPC(context.Context, stats.RPCStats)
HandleRPC processes the RPC stats.
func (*PoolServiceStatHandler) TagConn ¶
func (handler *PoolServiceStatHandler) TagConn(context.Context, *stats.ConnTagInfo) context.Context
func (*PoolServiceStatHandler) TagRPC ¶
func (handler *PoolServiceStatHandler) TagRPC(context.Context, *stats.RPCTagInfo) context.Context
type PoolSession ¶ added in v0.5.0
type PoolSession struct {
// contains filtered or unexported fields
}
PoolSession is a struct for client login
func NewPoolSession ¶ added in v0.5.0
func NewPoolSession(poolClientID string) *PoolSession
func (*PoolSession) AddPoolFileHandle ¶ added in v0.5.0
func (session *PoolSession) AddPoolFileHandle(poolFileHandle *PoolFileHandle)
func (*PoolSession) GetID ¶ added in v0.5.0
func (session *PoolSession) GetID() string
func (*PoolSession) GetIRODSFSClientInstanceID ¶ added in v0.5.0
func (session *PoolSession) GetIRODSFSClientInstanceID() string
func (*PoolSession) GetPoolClientID ¶ added in v0.5.0
func (session *PoolSession) GetPoolClientID() string
func (*PoolSession) GetPoolFileHandle ¶ added in v0.5.0
func (session *PoolSession) GetPoolFileHandle(poolFileHandleID string) *PoolFileHandle
func (*PoolSession) Release ¶ added in v0.5.0
func (session *PoolSession) Release()
func (*PoolSession) RemovePoolFileHandle ¶ added in v0.5.0
func (session *PoolSession) RemovePoolFileHandle(poolFileHandleID string)
func (*PoolSession) SetIRODSFSClientInstanceID ¶ added in v0.5.0
func (session *PoolSession) SetIRODSFSClientInstanceID(irodsFsClientInstanceID string)
func (*PoolSession) UpdateLastAccessTime ¶ added in v0.5.0
func (session *PoolSession) UpdateLastAccessTime()
type SessionNotFoundError ¶ added in v0.6.0
type SessionNotFoundError struct {
// contains filtered or unexported fields
}
SessionNotFoundError ...
func NewSessionNotFoundError ¶ added in v0.6.0
func NewSessionNotFoundError(message string) *SessionNotFoundError
NewSessionNotFoundError creates SessionNotFoundError struct
func NewSessionNotFoundErrorf ¶ added in v0.6.0
func NewSessionNotFoundErrorf(format string, v ...interface{}) *SessionNotFoundError
NewSessionNotFoundErrorf creates SessionNotFoundError struct
func (*SessionNotFoundError) Error ¶ added in v0.6.0
func (e *SessionNotFoundError) Error() string