Documentation
¶
Index ¶
- Constants
- type Account
- type DAVFSConfig
- type IRODSFSConfig
- type ListMountsFilter
- type MountConfig
- type MountEvent
- type MountEventStream
- type MountEventType
- type MountInfo
- type MountServiceClient
- func (client *MountServiceClient) Connect() error
- func (client *MountServiceClient) Disconnect()
- func (client *MountServiceClient) GetMount(mountID string) (*MountInfo, error)
- func (client *MountServiceClient) ListMounts(filter *ListMountsFilter) ([]*MountInfo, error)
- func (client *MountServiceClient) Mount(config *MountConfig, wait bool) (*MountInfo, error)
- func (client *MountServiceClient) MountWithID(mountID string, config *MountConfig, wait bool) (*MountInfo, error)
- func (client *MountServiceClient) Ready(ctx context.Context) error
- func (client *MountServiceClient) Unmount(mountID string) (*MountInfo, error)
- func (client *MountServiceClient) WatchMountEvents(ctx context.Context, request *WatchMountEventsRequest) (MountEventStream, error)
- type MountState
- type NFSConfig
- type PathMapping
- type WatchMountEventsRequest
Constants ¶
const ( MountStateUnspecified = api.MountState_MOUNT_STATE_UNSPECIFIED MountStatePendingMount = api.MountState_MOUNT_STATE_PENDING_MOUNT MountStateMounting = api.MountState_MOUNT_STATE_MOUNTING MountStateMounted = api.MountState_MOUNT_STATE_MOUNTED MountStatePendingUnmount = api.MountState_MOUNT_STATE_PENDING_UNMOUNT MountStateUnmounting = api.MountState_MOUNT_STATE_UNMOUNTING MountStateRetryWait = api.MountState_MOUNT_STATE_RETRY_WAIT MountStateFailed = api.MountState_MOUNT_STATE_FAILED MountEventTypeSnapshot = api.MountEventType_MOUNT_EVENT_TYPE_SNAPSHOT MountEventTypeUpdated = api.MountEventType_MOUNT_EVENT_TYPE_UPDATED MountEventTypeRemoved = api.MountEventType_MOUNT_EVENT_TYPE_REMOVED )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DAVFSConfig ¶
type DAVFSConfig = api.DAVFSConfig
type IRODSFSConfig ¶
type IRODSFSConfig = api.IRODSFSConfig
type ListMountsFilter ¶
type ListMountsFilter struct {
States []MountState
MountPathPrefix *string
ClientUser *string
}
ListMountsFilter selects mounts returned by MountServiceClient.ListMounts. Empty fields do not restrict the result.
type MountConfig ¶
type MountConfig = api.MountConfig
Public aliases keep the common client result and filter types available without requiring callers to rename the generated API package.
type MountEvent ¶
type MountEvent = api.MountEvent
type MountEventStream ¶
type MountEventStream = api.MountService_WatchMountEventsClient
type MountEventType ¶
type MountEventType = api.MountEventType
type MountServiceClient ¶
type MountServiceClient struct {
// contains filtered or unexported fields
}
MountServiceClient is a client of mount service
func NewMountServiceClient ¶
func NewMountServiceClient(address string, operationTimeout time.Duration, autoReconnect bool, logger *log.Entry) *MountServiceClient
NewMountServiceClient creates a new mount service client
func (*MountServiceClient) Connect ¶
func (client *MountServiceClient) Connect() error
Connect connects to mount service
func (*MountServiceClient) Disconnect ¶
func (client *MountServiceClient) Disconnect()
Disconnect disconnects connection from mount service
func (*MountServiceClient) GetMount ¶
func (client *MountServiceClient) GetMount(mountID string) (*MountInfo, error)
GetMount returns the mount identified by mountID.
func (*MountServiceClient) ListMounts ¶
func (client *MountServiceClient) ListMounts(filter *ListMountsFilter) ([]*MountInfo, error)
ListMounts returns mounts matching filter. A nil filter lists all mounts.
func (*MountServiceClient) Mount ¶
func (client *MountServiceClient) Mount(config *MountConfig, wait bool) (*MountInfo, error)
Mount requests a mount with a server-generated mount ID. When wait is true, it returns only after the mount reaches MOUNTED or FAILED.
func (*MountServiceClient) MountWithID ¶
func (client *MountServiceClient) MountWithID(mountID string, config *MountConfig, wait bool) (*MountInfo, error)
MountWithID requests a mount using mountID. An empty mountID has the same behavior as Mount and lets the server generate the ID. When wait is true, the client consumes the daemon's lifecycle event stream until the mount is usable or has failed.
func (*MountServiceClient) Ready ¶
func (client *MountServiceClient) Ready(ctx context.Context) error
Ready checks whether irodsfsd is available and its dependencies are ready.
func (*MountServiceClient) Unmount ¶
func (client *MountServiceClient) Unmount(mountID string) (*MountInfo, error)
Unmount requests removal of the mount identified by mountID.
func (*MountServiceClient) WatchMountEvents ¶
func (client *MountServiceClient) WatchMountEvents(ctx context.Context, request *WatchMountEventsRequest) (MountEventStream, error)
WatchMountEvents opens a server-streaming lifecycle event subscription. The caller owns ctx and should cancel it when it no longer needs events.
type MountState ¶
type MountState = api.MountState
type PathMapping ¶
type PathMapping = api.PathMapping
type WatchMountEventsRequest ¶
type WatchMountEventsRequest = api.WatchMountEventsRequest
Source Files