files.com 1.1.813 → 1.1.815
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/doc/Files/APIConnectionError.html +1 -1
- data/doc/Files/APIError.html +1 -1
- data/doc/Files/AccountAlreadyExistsError.html +1 -1
- data/doc/Files/AccountLineItem.html +1 -1
- data/doc/Files/AccountOverdueError.html +1 -1
- data/doc/Files/Action.html +1 -1
- data/doc/Files/ActionLog.html +1 -1
- data/doc/Files/ActionNotificationExport.html +1 -1
- data/doc/Files/ActionNotificationExportResult.html +1 -1
- data/doc/Files/AdditionalAuthenticationRequiredError.html +1 -1
- data/doc/Files/AgentNode.html +1 -1
- data/doc/Files/AgentNodeConnection.html +1 -1
- data/doc/Files/AgentNodeInstance.html +1 -1
- data/doc/Files/AgentPushUpdate.html +1 -1
- data/doc/Files/AgentPushUpdateBlockedError.html +1 -1
- data/doc/Files/AgentUnavailableError.html +1 -1
- data/doc/Files/AgentUpgradeRequiredError.html +1 -1
- data/doc/Files/AiAssistantPersonality.html +1 -1
- data/doc/Files/AiTask.html +1 -1
- data/doc/Files/AiTaskCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AlreadyCompletedError.html +1 -1
- data/doc/Files/Api.html +20 -13
- data/doc/Files/ApiClient/RequestLogContext.html +29 -29
- data/doc/Files/ApiClient/TransferSettings.html +721 -0
- data/doc/Files/ApiClient.html +756 -204
- data/doc/Files/ApiKey.html +1 -1
- data/doc/Files/ApiKeyIsDisabledError.html +1 -1
- data/doc/Files/ApiKeyIsPathRestrictedError.html +1 -1
- data/doc/Files/ApiKeyNotFoundError.html +1 -1
- data/doc/Files/ApiKeyOnlyForDesktopAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForFileOperationsError.html +1 -1
- data/doc/Files/ApiKeyOnlyForMobileAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForOfficeIntegrationError.html +1 -1
- data/doc/Files/ApiKeySessionsNotSupportedError.html +1 -1
- data/doc/Files/ApiRequestLog.html +1 -1
- data/doc/Files/App.html +1 -1
- data/doc/Files/As2IncomingMessage.html +1 -1
- data/doc/Files/As2OutgoingMessage.html +1 -1
- data/doc/Files/As2Partner.html +1 -1
- data/doc/Files/As2Station.html +1 -1
- data/doc/Files/AttachmentTooLargeError.html +1 -1
- data/doc/Files/AuthenticationError.html +1 -1
- data/doc/Files/AuthenticationRequiredError.html +1 -1
- data/doc/Files/Auto.html +1 -1
- data/doc/Files/Automation.html +1 -1
- data/doc/Files/AutomationAuthoringSchema.html +1 -1
- data/doc/Files/AutomationCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AutomationExecutionNode.html +1 -1
- data/doc/Files/AutomationLog.html +1 -1
- data/doc/Files/AutomationRun.html +1 -1
- data/doc/Files/AutomationsUnavailableError.html +1 -1
- data/doc/Files/BadRequestError.html +1 -1
- data/doc/Files/BandwidthSnapshot.html +1 -1
- data/doc/Files/Behavior.html +1 -1
- data/doc/Files/BehaviorNotAllowedOnRemoteServerError.html +1 -1
- data/doc/Files/BillingInformationHiddenError.html +1 -1
- data/doc/Files/BillingPermissionRequiredError.html +1 -1
- data/doc/Files/BufferedUploadDisabledForThisDestinationError.html +1 -1
- data/doc/Files/Bundle.html +1 -1
- data/doc/Files/BundleAction.html +1 -1
- data/doc/Files/BundleDownload.html +1 -1
- data/doc/Files/BundleMaximumUsesReachedError.html +1 -1
- data/doc/Files/BundleNotification.html +1 -1
- data/doc/Files/BundleOnlyAllowsPreviewsError.html +1 -1
- data/doc/Files/BundleOperationRequiresSubfolderError.html +1 -1
- data/doc/Files/BundlePath.html +1 -1
- data/doc/Files/BundlePathNotFoundError.html +1 -1
- data/doc/Files/BundlePermissionRequiredError.html +1 -1
- data/doc/Files/BundleRecipient.html +1 -1
- data/doc/Files/BundleRegistration.html +1 -1
- data/doc/Files/BundleRegistrationCodeFailedError.html +1 -1
- data/doc/Files/BundleRegistrationNotFoundError.html +1 -1
- data/doc/Files/CannotAdministerHigherLevelUserError.html +1 -1
- data/doc/Files/CannotDownloadDirectoryError.html +1 -1
- data/doc/Files/CannotLoginWhileUsingKeyError.html +1 -1
- data/doc/Files/CantActForOtherUserError.html +1 -1
- data/doc/Files/CantMoveWithMultipleLocationsError.html +1 -1
- data/doc/Files/ChatMessage.html +1 -1
- data/doc/Files/ChatSession.html +1 -1
- data/doc/Files/ChildSiteManagementPolicy.html +1 -1
- data/doc/Files/Clickwrap.html +1 -1
- data/doc/Files/CodeNotFoundError.html +1 -1
- data/doc/Files/ConfigurationLockedPathError.html +1 -1
- data/doc/Files/ContactAdminForPasswordChangeHelpError.html +1 -1
- data/doc/Files/CouldNotCreateParentError.html +1 -1
- data/doc/Files/CustomDomain.html +1 -1
- data/doc/Files/DatetimeParseError.html +1 -1
- data/doc/Files/DesktopConfigurationProfile.html +1 -1
- data/doc/Files/DestinationExistsError.html +1 -1
- data/doc/Files/DestinationFolderLimitedError.html +1 -1
- data/doc/Files/DestinationParentConflictError.html +1 -1
- data/doc/Files/DestinationParentDoesNotExistError.html +1 -1
- data/doc/Files/DestinationSameError.html +1 -1
- data/doc/Files/DestinationSiteMismatchError.html +1 -1
- data/doc/Files/DirectConnectionInfo.html +1 -1
- data/doc/Files/DnsRecord.html +1 -1
- data/doc/Files/DoesNotSupportSortingError.html +1 -1
- data/doc/Files/DuplicateShareRecipientError.html +1 -1
- data/doc/Files/EmailIncomingMessage.html +1 -1
- data/doc/Files/EmailLog.html +1 -1
- data/doc/Files/Error.html +2 -2
- data/doc/Files/Errors.html +1 -1
- data/doc/Files/EventChannel.html +1 -1
- data/doc/Files/EventDeliveryAttempt.html +1 -1
- data/doc/Files/EventRecord.html +1 -1
- data/doc/Files/EventSubscription.html +1 -1
- data/doc/Files/EventTarget.html +1 -1
- data/doc/Files/ExavaultApiRequestLog.html +1 -1
- data/doc/Files/ExceededRuntimeLimitError.html +1 -1
- data/doc/Files/Expectation.html +1 -1
- data/doc/Files/ExpectationAlreadyHasOpenWindowError.html +1 -1
- data/doc/Files/ExpectationEvaluation.html +1 -1
- data/doc/Files/ExpectationIncident.html +1 -1
- data/doc/Files/ExpectationNotManualTriggerError.html +1 -1
- data/doc/Files/ExpiredPrivateKeyError.html +1 -1
- data/doc/Files/ExpiredPublicKeyError.html +1 -1
- data/doc/Files/ExportFailureError.html +1 -1
- data/doc/Files/ExportNotReadyError.html +1 -1
- data/doc/Files/ExternalEvent.html +1 -1
- data/doc/Files/FailedToChangePasswordError.html +1 -1
- data/doc/Files/File.html +2019 -1515
- data/doc/Files/FileAction.html +1 -1
- data/doc/Files/FileActionError.html +1 -1
- data/doc/Files/FileComment.html +1 -1
- data/doc/Files/FileCommentReaction.html +1 -1
- data/doc/Files/FileLockedError.html +1 -1
- data/doc/Files/FileMigration.html +1 -1
- data/doc/Files/FileMigrationLog.html +1 -1
- data/doc/Files/FileNotFoundError.html +1 -1
- data/doc/Files/FileNotUploadedError.html +1 -1
- data/doc/Files/FilePendingProcessingError.html +1 -1
- data/doc/Files/FileProcessingErrorError.html +1 -1
- data/doc/Files/FileTooBigToDecryptError.html +1 -1
- data/doc/Files/FileTooBigToEncryptError.html +1 -1
- data/doc/Files/FileUploadNotFoundError.html +1 -1
- data/doc/Files/FileUploadPart.html +1 -1
- data/doc/Files/FileUploadedToWrongRegionError.html +1 -1
- data/doc/Files/FileUtils.html +1 -1
- data/doc/Files/FilenameTooLongError.html +1 -1
- data/doc/Files/FilesAgentFailedAuthorizationError.html +1 -1
- data/doc/Files/FilesNativeStorageOverloadedError.html +1 -1
- data/doc/Files/Folder.html +1 -1
- data/doc/Files/FolderAdminOrBillingPermissionRequiredError.html +1 -1
- data/doc/Files/FolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/FolderLockedError.html +1 -1
- data/doc/Files/FolderMustNotBeAFileError.html +1 -1
- data/doc/Files/FolderNotEmptyError.html +1 -1
- data/doc/Files/FoldersNotAllowedError.html +1 -1
- data/doc/Files/FormField.html +1 -1
- data/doc/Files/FormFieldSet.html +1 -1
- data/doc/Files/FtpActionLog.html +1 -1
- data/doc/Files/FullPermissionRequiredError.html +1 -1
- data/doc/Files/GpgKey.html +1 -1
- data/doc/Files/Group.html +1 -1
- data/doc/Files/GroupNotFoundError.html +1 -1
- data/doc/Files/GroupUser.html +1 -1
- data/doc/Files/History.html +1 -1
- data/doc/Files/HistoryExport.html +1 -1
- data/doc/Files/HistoryExportResult.html +1 -1
- data/doc/Files/HistoryPermissionRequiredError.html +1 -1
- data/doc/Files/HistoryUnavailableError.html +1 -1
- data/doc/Files/HolidayCalendar.html +1 -1
- data/doc/Files/HolidayRegion.html +1 -1
- data/doc/Files/Image.html +1 -1
- data/doc/Files/InAppAiAssistantUnavailableError.html +1 -1
- data/doc/Files/InboundS3Log.html +1 -1
- data/doc/Files/InboxNotFoundError.html +1 -1
- data/doc/Files/InboxRecipient.html +1 -1
- data/doc/Files/InboxRegistration.html +1 -1
- data/doc/Files/InboxRegistrationCodeFailedError.html +1 -1
- data/doc/Files/InboxUpload.html +1 -1
- data/doc/Files/InsufficientPermissionForParamsError.html +1 -1
- data/doc/Files/InsufficientPermissionForSiteError.html +1 -1
- data/doc/Files/IntegrationCentricProfile.html +1 -1
- data/doc/Files/InternalGeneralErrorError.html +1 -1
- data/doc/Files/InvalidBodyError.html +1 -1
- data/doc/Files/InvalidBundleCodeError.html +1 -1
- data/doc/Files/InvalidCredentialsError.html +1 -1
- data/doc/Files/InvalidCursorError.html +1 -1
- data/doc/Files/InvalidCursorTypeForSortError.html +1 -1
- data/doc/Files/InvalidEtagsError.html +1 -1
- data/doc/Files/InvalidFileTypeError.html +1 -1
- data/doc/Files/InvalidFilenameError.html +1 -1
- data/doc/Files/InvalidFilterAliasCombinationError.html +1 -1
- data/doc/Files/InvalidFilterFieldError.html +1 -1
- data/doc/Files/InvalidFilterParamError.html +1 -1
- data/doc/Files/InvalidFilterParamFormatError.html +1 -1
- data/doc/Files/InvalidFilterParamValueError.html +1 -1
- data/doc/Files/InvalidInputEncodingError.html +1 -1
- data/doc/Files/InvalidInterfaceError.html +1 -1
- data/doc/Files/InvalidOauthError.html +1 -1
- data/doc/Files/InvalidOauthProviderError.html +1 -1
- data/doc/Files/InvalidOrExpiredCodeError.html +1 -1
- data/doc/Files/InvalidParameterError.html +5 -1
- data/doc/Files/InvalidPathError.html +1 -1
- data/doc/Files/InvalidPriorityColorError.html +1 -1
- data/doc/Files/InvalidRangeError.html +1 -1
- data/doc/Files/InvalidReturnToUrlError.html +1 -1
- data/doc/Files/InvalidSearchQueryError.html +1 -1
- data/doc/Files/InvalidSessionError.html +1 -1
- data/doc/Files/InvalidSiteError.html +1 -1
- data/doc/Files/InvalidSortFieldError.html +1 -1
- data/doc/Files/InvalidSortFilterCombinationError.html +1 -1
- data/doc/Files/InvalidUploadOffsetError.html +1 -1
- data/doc/Files/InvalidUploadPartGapError.html +1 -1
- data/doc/Files/InvalidUploadPartSizeError.html +1 -1
- data/doc/Files/InvalidUsernameOrPasswordError.html +1 -1
- data/doc/Files/InvalidWorkspaceIdHeaderError.html +1 -1
- data/doc/Files/InvalidZipFileError.html +1 -1
- data/doc/Files/Invoice.html +1 -1
- data/doc/Files/InvoiceLineItem.html +1 -1
- data/doc/Files/IpAddress.html +1 -1
- data/doc/Files/KeyLifecycleRule.html +1 -1
- data/doc/Files/List.html +1 -1
- data/doc/Files/Lock.html +1 -1
- data/doc/Files/LockOperationBusyError.html +1 -1
- data/doc/Files/LockedOutError.html +1 -1
- data/doc/Files/LockoutRegionMismatchError.html +1 -1
- data/doc/Files/MetadataCategory.html +1 -1
- data/doc/Files/MetadataNotSupportedOnRemotesError.html +1 -1
- data/doc/Files/MethodNotAllowedError.html +1 -1
- data/doc/Files/MigrationInProgressError.html +1 -1
- data/doc/Files/MissingParameterError.html +1 -1
- data/doc/Files/ModelSaveErrorError.html +1 -1
- data/doc/Files/MoverAccessDeniedError.html +1 -1
- data/doc/Files/MoverPackageRequiredError.html +1 -1
- data/doc/Files/MultipleProcessingErrorsError.html +1 -1
- data/doc/Files/MultipleSortParamsNotAllowedError.html +1 -1
- data/doc/Files/MustAuthenticateWithApiKeyError.html +1 -1
- data/doc/Files/NeedAdminPermissionForInboxError.html +1 -1
- data/doc/Files/NestedNotFoundError.html +1 -1
- data/doc/Files/NoAccountForSiteError.html +1 -1
- data/doc/Files/NoValidInputParamsError.html +1 -1
- data/doc/Files/NonAdminsMustQueryByFolderOrPathError.html +1 -1
- data/doc/Files/NotAllowedToCreateBundleError.html +1 -1
- data/doc/Files/NotAuthenticatedError.html +1 -1
- data/doc/Files/NotAuthorizedError.html +1 -1
- data/doc/Files/NotEnqueuableSyncError.html +1 -1
- data/doc/Files/NotFoundError.html +1 -1
- data/doc/Files/NotImplementedError.html +1 -1
- data/doc/Files/Notification.html +1 -1
- data/doc/Files/OffsetUploadNotAllowedWithMalwareScanningError.html +1 -1
- data/doc/Files/OneTimePasswordIncorrectError.html +1 -1
- data/doc/Files/OutboundConnectionLog.html +1 -1
- data/doc/Files/PartNumberTooLargeError.html +1 -1
- data/doc/Files/Partner.html +1 -1
- data/doc/Files/PartnerChannel.html +1 -1
- data/doc/Files/PartnerChannelTemplate.html +1 -1
- data/doc/Files/PartnerConnection.html +1 -1
- data/doc/Files/PartnerSite.html +1 -1
- data/doc/Files/PartnerSiteRequest.html +1 -1
- data/doc/Files/PasswordChangeNotRequiredError.html +1 -1
- data/doc/Files/PasswordChangeRequiredError.html +1 -1
- data/doc/Files/PathCannotHaveTrailingWhitespaceError.html +1 -1
- data/doc/Files/PathTooLongError.html +1 -1
- data/doc/Files/PathUtil.html +1 -1
- data/doc/Files/Payment.html +1 -1
- data/doc/Files/PaymentLineItem.html +1 -1
- data/doc/Files/PaymentMethodErrorError.html +1 -1
- data/doc/Files/PendingWorkEvent.html +1 -1
- data/doc/Files/Permission.html +1 -1
- data/doc/Files/PlanNotFoundError.html +1 -1
- data/doc/Files/Preview.html +1 -1
- data/doc/Files/PreviewOnlyPermissionCannotDownloadError.html +1 -1
- data/doc/Files/ProcessingFailureError.html +1 -1
- data/doc/Files/PublicHostingRequestLog.html +1 -1
- data/doc/Files/PublicIpAddress.html +1 -1
- data/doc/Files/PublicKey.html +1 -1
- data/doc/Files/RateLimitedError.html +1 -1
- data/doc/Files/ReadOnlySessionError.html +1 -1
- data/doc/Files/ReadPermissionRequiredError.html +1 -1
- data/doc/Files/ReauthenticationFailedError.html +1 -1
- data/doc/Files/ReauthenticationFailedFinalError.html +1 -1
- data/doc/Files/ReauthenticationNeededActionError.html +1 -1
- data/doc/Files/ReauthenticationNeededFieldsError.html +1 -1
- data/doc/Files/ReauthenticationRateLimitedError.html +1 -1
- data/doc/Files/RecaptchaFailedError.html +1 -1
- data/doc/Files/RecipientAlreadySharedError.html +1 -1
- data/doc/Files/RemoteBandwidthSnapshot.html +1 -1
- data/doc/Files/RemoteDesktopDebugLoggingDisabledError.html +1 -1
- data/doc/Files/RemoteEntryReadOnlyError.html +1 -1
- data/doc/Files/RemoteMountBackend.html +1 -1
- data/doc/Files/RemoteServer.html +1 -1
- data/doc/Files/RemoteServerConfigurationFile.html +1 -1
- data/doc/Files/RemoteServerCredential.html +1 -1
- data/doc/Files/RemoteServerErrorError.html +1 -1
- data/doc/Files/Request.html +1 -1
- data/doc/Files/RequestBodyTooLargeError.html +1 -1
- data/doc/Files/RequestParamsContainInvalidCharacterError.html +1 -1
- data/doc/Files/RequestParamsInvalidError.html +1 -1
- data/doc/Files/RequestParamsRequiredError.html +1 -1
- data/doc/Files/ResourceBelongsToParentSiteError.html +1 -1
- data/doc/Files/ResourceLockedError.html +1 -1
- data/doc/Files/Response.html +1 -1
- data/doc/Files/Restore.html +1 -1
- data/doc/Files/RootFolderBehaviorSiteAdminRequiredError.html +1 -1
- data/doc/Files/RootFolderBehaviorSkipSiteAdminRequiredError.html +1 -1
- data/doc/Files/Schedule.html +1 -1
- data/doc/Files/ScheduledExport.html +1 -1
- data/doc/Files/ScimLog.html +1 -1
- data/doc/Files/SearchAllOnChildPathError.html +1 -1
- data/doc/Files/SearchUnavailableError.html +1 -1
- data/doc/Files/Secret.html +1 -1
- data/doc/Files/SelfManagedRequiredError.html +1 -1
- data/doc/Files/ServiceUnavailableError.html +1 -1
- data/doc/Files/Session.html +1 -1
- data/doc/Files/SettingsChange.html +1 -1
- data/doc/Files/SftpActionLog.html +1 -1
- data/doc/Files/SftpHostKey.html +1 -1
- data/doc/Files/ShareGroup.html +1 -1
- data/doc/Files/ShareGroupMember.html +1 -1
- data/doc/Files/SiemHttpDestination.html +1 -1
- data/doc/Files/SiemHttpDestinationEvent.html +1 -1
- data/doc/Files/Site.html +911 -731
- data/doc/Files/SiteAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminRequiredError.html +1 -1
- data/doc/Files/SiteConfigurationError.html +1 -1
- data/doc/Files/SiteDisabledError.html +1 -1
- data/doc/Files/SiteFilesAreImmutableError.html +1 -1
- data/doc/Files/SiteNotFoundError.html +1 -1
- data/doc/Files/SiteSubdomainRedirect.html +1 -1
- data/doc/Files/SiteWasRemovedError.html +1 -1
- data/doc/Files/SizableIO.html +1 -1
- data/doc/Files/Snapshot.html +1 -1
- data/doc/Files/SsoEvent.html +1 -1
- data/doc/Files/SsoStrategy.html +1 -1
- data/doc/Files/Status.html +1 -1
- data/doc/Files/Style.html +1 -1
- data/doc/Files/SubfolderLockedError.html +1 -1
- data/doc/Files/Sync.html +1 -1
- data/doc/Files/SyncInProgressError.html +1 -1
- data/doc/Files/SyncLog.html +1 -1
- data/doc/Files/SyncRun.html +1 -1
- data/doc/Files/SyncRunLiveTransfer.html +1 -1
- data/doc/Files/SystemProfiler.html +1 -1
- data/doc/Files/TooManyConcurrentLoginsError.html +1 -1
- data/doc/Files/TooManyConcurrentRequestsError.html +1 -1
- data/doc/Files/TooManyLoginAttemptsError.html +1 -1
- data/doc/Files/TooManyRequestsError.html +1 -1
- data/doc/Files/TooManySharesError.html +1 -1
- data/doc/Files/Transfer/BufferLimitError.html +175 -0
- data/doc/Files/Transfer/ByteBudget/Reservation.html +301 -0
- data/doc/Files/Transfer/ByteBudget.html +748 -0
- data/doc/Files/Transfer/CancelledError.html +235 -0
- data/doc/Files/Transfer/Checkpoint.html +1371 -0
- data/doc/Files/Transfer/CheckpointError.html +173 -0
- data/doc/Files/Transfer/ClientTransport/ClientResponse.html +661 -0
- data/doc/Files/Transfer/ClientTransport/Reader.html +530 -0
- data/doc/Files/Transfer/ClientTransport.html +675 -0
- data/doc/Files/Transfer/Clock.html +189 -0
- data/doc/Files/Transfer/Control.html +667 -0
- data/doc/Files/Transfer/Controller/Attempt.html +465 -0
- data/doc/Files/Transfer/Controller.html +1166 -0
- data/doc/Files/Transfer/Coordinator/Timing.html +568 -0
- data/doc/Files/Transfer/Coordinator.html +534 -0
- data/doc/Files/Transfer/DownloadCoordinator/FileSink.html +976 -0
- data/doc/Files/Transfer/DownloadCoordinator/IoSink.html +1168 -0
- data/doc/Files/Transfer/DownloadCoordinator/Piece.html +875 -0
- data/doc/Files/Transfer/DownloadCoordinator.html +728 -0
- data/doc/Files/Transfer/FileSlots.html +480 -0
- data/doc/Files/Transfer/FrontendResponseError.html +235 -0
- data/doc/Files/Transfer/Holds.html +505 -0
- data/doc/Files/Transfer/HttpTransport.html +579 -0
- data/doc/Files/Transfer/Job.html +2338 -0
- data/doc/Files/Transfer/Options.html +924 -0
- data/doc/Files/Transfer/PausedError.html +319 -0
- data/doc/Files/Transfer/Policy.html +1642 -0
- data/doc/Files/Transfer/RequestPermits.html +160 -0
- data/doc/Files/Transfer/SourceChangedError.html +235 -0
- data/doc/Files/Transfer/StorageResponse.html +546 -0
- data/doc/Files/Transfer/StorageRetry.html +1098 -0
- data/doc/Files/Transfer/UploadCoordinator/Grant.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Part.html +1048 -0
- data/doc/Files/Transfer/UploadCoordinator/Region.html +295 -0
- data/doc/Files/Transfer/UploadCoordinator/Segments.html +299 -0
- data/doc/Files/Transfer/UploadCoordinator/Source.html +725 -0
- data/doc/Files/Transfer/UploadCoordinator/StreamSource.html +664 -0
- data/doc/Files/Transfer/UploadCoordinator.html +546 -0
- data/doc/Files/Transfer/UploadPlan.html +522 -0
- data/doc/Files/Transfer/VersionChangedError.html +235 -0
- data/doc/Files/Transfer.html +134 -0
- data/doc/Files/TrialExpiredError.html +1 -1
- data/doc/Files/TrialLockedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCodeAlreadySentError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCountryBlacklistedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationGeneralErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationMethodUnsupportedErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationRequiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationSetupExpiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationUnsubscribedRecipientError.html +1 -1
- data/doc/Files/URI.html +1 -1
- data/doc/Files/UnrecognizedSortIndexError.html +1 -1
- data/doc/Files/UnsupportedCurrencyError.html +1 -1
- data/doc/Files/UnsupportedHttpResponseFormatError.html +1 -1
- data/doc/Files/UnsupportedMediaTypeError.html +1 -1
- data/doc/Files/UpdatesNotAllowedForRemotesError.html +1 -1
- data/doc/Files/UploadsUnavailableError.html +1 -1
- data/doc/Files/UsageByTopLevelDir.html +1 -1
- data/doc/Files/UsageDailySnapshot.html +1 -1
- data/doc/Files/UsageSnapshot.html +1 -1
- data/doc/Files/User.html +597 -386
- data/doc/Files/UserAdditionalEmailRecipient.html +1 -1
- data/doc/Files/UserCipherUse.html +1 -1
- data/doc/Files/UserIdInvalidError.html +1 -1
- data/doc/Files/UserIdOnUserEndpointError.html +1 -1
- data/doc/Files/UserIdWithoutSiteAdminError.html +1 -1
- data/doc/Files/UserLifecycleRule.html +1 -1
- data/doc/Files/UserNotFoundError.html +1 -1
- data/doc/Files/UserRequest.html +1 -1
- data/doc/Files/UserRequestsEnabledRequiredError.html +1 -1
- data/doc/Files/UserRequiredError.html +1 -1
- data/doc/Files/UserSecurityEvent.html +1 -1
- data/doc/Files/UserSftpClientUse.html +1 -1
- data/doc/Files/Util/LogSettings.html +1 -1
- data/doc/Files/Util.html +1 -1
- data/doc/Files/WebDavActionLog.html +1 -1
- data/doc/Files/WebhookTest.html +1 -1
- data/doc/Files/Workspace.html +1 -1
- data/doc/Files/WriteAndBundlePermissionRequiredError.html +1 -1
- data/doc/Files/WritePermissionRequiredError.html +1 -1
- data/doc/Files/ZipListEntry.html +1 -1
- data/doc/Files.html +116 -116
- data/doc/_index.html +314 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +5368 -3048
- data/doc/top-level-namespace.html +1 -1
- data/docs/file.md +346 -0
- data/docs/site.md +10 -0
- data/docs/user.md +8 -0
- data/lib/files.com/api.rb +6 -1
- data/lib/files.com/api_client.rb +220 -32
- data/lib/files.com/models/file.rb +124 -17
- data/lib/files.com/models/site.rb +16 -0
- data/lib/files.com/models/user.rb +19 -0
- data/lib/files.com/transfer/budgets.rb +123 -0
- data/lib/files.com/transfer/checkpoint.rb +113 -0
- data/lib/files.com/transfer/clock.rb +14 -0
- data/lib/files.com/transfer/controller.rb +549 -0
- data/lib/files.com/transfer/download_coordinator.rb +906 -0
- data/lib/files.com/transfer/errors.rb +100 -0
- data/lib/files.com/transfer/http_transport.rb +337 -0
- data/lib/files.com/transfer/job.rb +778 -0
- data/lib/files.com/transfer/options.rb +126 -0
- data/lib/files.com/transfer/policy.rb +91 -0
- data/lib/files.com/transfer/storage_retry.rb +169 -0
- data/lib/files.com/transfer/upload_coordinator.rb +657 -0
- data/lib/files.com/transfer/upload_plan.rb +157 -0
- data/lib/files.com.rb +13 -0
- data/spec/lib/api_client_spec.rb +125 -3
- data/spec/models/file_transfer_spec.rb +53 -4
- data/spec/support/transfer_server.rb +113 -14
- data/spec/transfer/adaptive_download_spec.rb +1102 -0
- data/spec/transfer/adaptive_upload_spec.rb +1602 -0
- data/spec/transfer/concurrency_controller_spec.rb +382 -0
- data/spec/workspace_id_spec.rb +19 -14
- metadata +59 -1
|
@@ -0,0 +1,1371 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Files::Transfer::Checkpoint
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.45
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css">
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css">
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Files::Transfer::Checkpoint";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div id="main_progress" aria-hidden="true"></div>
|
|
31
|
+
|
|
32
|
+
<div class="nav_wrap">
|
|
33
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
34
|
+
<div id="resizer"></div>
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<div id="main" tabindex="-1">
|
|
38
|
+
<div id="header">
|
|
39
|
+
<div id="menu">
|
|
40
|
+
|
|
41
|
+
<a href="../../_index.html">Index (C)</a> »
|
|
42
|
+
<span class='title'><span class='object_link'><a href="../../Files.html" title="Files (module)">Files</a></span></span> » <span class='title'><span class='object_link'><a href="../Transfer.html" title="Files::Transfer (module)">Transfer</a></span></span>
|
|
43
|
+
»
|
|
44
|
+
<span class="title">Checkpoint</span>
|
|
45
|
+
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<div id="search">
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="class_list_link"
|
|
51
|
+
href="../../class_list.html">
|
|
52
|
+
|
|
53
|
+
<svg width="24" height="24">
|
|
54
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
56
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
57
|
+
</svg>
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Files::Transfer::Checkpoint
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Files::Transfer::Checkpoint</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/files.com/transfer/checkpoint.rb
|
|
100
|
+
</dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
<h2>Overview</h2><div class="docstring">
|
|
106
|
+
<div class="discussion">
|
|
107
|
+
<p>Where a paused transfer stopped, for Files::File.resume_upload or Files::File.resume_download in the same process.</p>
|
|
108
|
+
<p>It holds no credentials, signed URLs, API options or API response fields; resuming takes the options again. It
|
|
109
|
+
records, frozen, what it must find unchanged: an upload's local file (device, inode, size and modification
|
|
110
|
+
time), its reference, the upload parameters it began with (only mkdir_parents, with_rename and size), a
|
|
111
|
+
fingerprint of each part's instructions (a SHA-256 digest of their method, headers, size and retry rules, never
|
|
112
|
+
their URL) and the parts storage acknowledged; a download's destination (a local file's device and inode, or the
|
|
113
|
+
caller's IO object itself), the number of bytes written to it with a SHA-256 digest of them, and the remote
|
|
114
|
+
file's version. Resuming refuses with CheckpointError, before it sends, writes or truncates anything, when any of
|
|
115
|
+
them changed; a renewed part whose instructions differ stops the upload, and a download stops with
|
|
116
|
+
VersionChangedError when storage no longer has that version.</p>
|
|
117
|
+
<p>One resume at a time holds it. Once that resume has checked the local file or destination and starts its
|
|
118
|
+
transfer, the checkpoint is spent for good, however the transfer ends: a pause then gives a new checkpoint. Only a
|
|
119
|
+
resume refused before it started, as above, or paused or cancelled before its turn or before it finished those
|
|
120
|
+
checks, leaves it usable. It cannot be dumped or resumed in another process.</p>
|
|
121
|
+
|
|
122
|
+
</div>
|
|
123
|
+
</div>
|
|
124
|
+
<div class="tags">
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
132
|
+
<ul class="summary">
|
|
133
|
+
|
|
134
|
+
<li class="public ">
|
|
135
|
+
<span class="summary_signature">
|
|
136
|
+
|
|
137
|
+
<a href="#completed_bytes-instance_method" title="#completed_bytes (instance method)">#<strong>completed_bytes</strong> ⇒ Object </a>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</span>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="note title readonly">readonly</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute completed_bytes.</p></div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<li class="public ">
|
|
162
|
+
<span class="summary_signature">
|
|
163
|
+
|
|
164
|
+
<a href="#direction-instance_method" title="#direction (instance method)">#<strong>direction</strong> ⇒ Object </a>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</span>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="note title readonly">readonly</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute direction.</p></div></span>
|
|
184
|
+
|
|
185
|
+
</li>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<li class="public ">
|
|
189
|
+
<span class="summary_signature">
|
|
190
|
+
|
|
191
|
+
<a href="#local_path-instance_method" title="#local_path (instance method)">#<strong>local_path</strong> ⇒ Object </a>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</span>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="note title readonly">readonly</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute local_path.</p></div></span>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<li class="public ">
|
|
216
|
+
<span class="summary_signature">
|
|
217
|
+
|
|
218
|
+
<a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong> ⇒ Object </a>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<span class="note title readonly">readonly</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute path.</p></div></span>
|
|
238
|
+
|
|
239
|
+
</li>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
<li class="public ">
|
|
243
|
+
<span class="summary_signature">
|
|
244
|
+
|
|
245
|
+
<a href="#sink-instance_method" title="#sink (instance method)">#<strong>sink</strong> ⇒ Object </a>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<span class="note title readonly">readonly</span>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute sink.</p></div></span>
|
|
265
|
+
|
|
266
|
+
</li>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<li class="public ">
|
|
270
|
+
<span class="summary_signature">
|
|
271
|
+
|
|
272
|
+
<a href="#source-instance_method" title="#source (instance method)">#<strong>source</strong> ⇒ Object </a>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
</span>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<span class="note title readonly">readonly</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute source.</p></div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> ⇒ Object </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<span class="note title readonly">readonly</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute state.</p></div></span>
|
|
319
|
+
|
|
320
|
+
</li>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<li class="public ">
|
|
324
|
+
<span class="summary_signature">
|
|
325
|
+
|
|
326
|
+
<a href="#total_bytes-instance_method" title="#total_bytes (instance method)">#<strong>total_bytes</strong> ⇒ Object </a>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</span>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="note title readonly">readonly</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute total_bytes.</p></div></span>
|
|
346
|
+
|
|
347
|
+
</li>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<li class="public ">
|
|
351
|
+
<span class="summary_signature">
|
|
352
|
+
|
|
353
|
+
<a href="#version-instance_method" title="#version (instance method)">#<strong>version</strong> ⇒ Object </a>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</span>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<span class="note title readonly">readonly</span>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute version.</p></div></span>
|
|
373
|
+
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
</ul>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
<h2>
|
|
384
|
+
Class Method Summary
|
|
385
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
386
|
+
</h2>
|
|
387
|
+
|
|
388
|
+
<ul class="summary">
|
|
389
|
+
|
|
390
|
+
<li class="public ">
|
|
391
|
+
<span class="summary_signature">
|
|
392
|
+
|
|
393
|
+
<a href="#frozen-class_method" title="frozen (class method)">.<strong>frozen</strong>(value) ⇒ Object </a>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
</span>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
<span class="summary_desc"><div class='inline'><p>A frozen copy of value's Hashes, Arrays and Strings, all the way down.</p></div></span>
|
|
408
|
+
|
|
409
|
+
</li>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<li class="public ">
|
|
413
|
+
<span class="summary_signature">
|
|
414
|
+
|
|
415
|
+
<a href="#identity-class_method" title="identity (class method)">.<strong>identity</strong>(stat, contents: true) ⇒ Object </a>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
</span>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<span class="summary_desc"><div class='inline'><p>The identity of an opened local file, from its stat: [device, inode], with size and modification time unless contents is false.</p></div></span>
|
|
430
|
+
|
|
431
|
+
</li>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</ul>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<h2>
|
|
438
|
+
Instance Method Summary
|
|
439
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
440
|
+
</h2>
|
|
441
|
+
|
|
442
|
+
<ul class="summary">
|
|
443
|
+
|
|
444
|
+
<li class="public ">
|
|
445
|
+
<span class="summary_signature">
|
|
446
|
+
|
|
447
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(direction:, path:, total_bytes:, completed_bytes:, local_path: nil, source: nil, sink: nil, version: nil, state: {}) ⇒ Checkpoint </a>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</span>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<span class="note title constructor">constructor</span>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Checkpoint.</p></div></span>
|
|
464
|
+
|
|
465
|
+
</li>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<li class="public ">
|
|
469
|
+
<span class="summary_signature">
|
|
470
|
+
|
|
471
|
+
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</span>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
486
|
+
|
|
487
|
+
</li>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
<li class="public ">
|
|
491
|
+
<span class="summary_signature">
|
|
492
|
+
|
|
493
|
+
<a href="#marshal_dump-instance_method" title="#marshal_dump (instance method)">#<strong>marshal_dump</strong> ⇒ Object </a>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</span>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
508
|
+
|
|
509
|
+
</li>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
<li class="public ">
|
|
513
|
+
<span class="summary_signature">
|
|
514
|
+
|
|
515
|
+
<a href="#resuming-instance_method" title="#resuming (instance method)">#<strong>resuming</strong>(direction) ⇒ Object </a>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<span class="summary_desc"><div class='inline'><p>Runs the block, which resumes the transfer in direction, as the one resume holding this checkpoint, and returns what it returns.</p></div></span>
|
|
530
|
+
|
|
531
|
+
</li>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<li class="public ">
|
|
535
|
+
<span class="summary_signature">
|
|
536
|
+
|
|
537
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
552
|
+
|
|
553
|
+
</li>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<li class="public ">
|
|
557
|
+
<span class="summary_signature">
|
|
558
|
+
|
|
559
|
+
<a href="#verify!-instance_method" title="#verify! (instance method)">#<strong>verify!</strong>(direction) ⇒ Object </a>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</span>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<span class="summary_desc"><div class='inline'><p>Raises CheckpointError unless this checkpoint can resume a transfer in direction (:upload or :download).</p></div></span>
|
|
574
|
+
|
|
575
|
+
</li>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
</ul>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<div id="constructor_details" class="method_details_list">
|
|
583
|
+
<h2>Constructor Details</h2>
|
|
584
|
+
|
|
585
|
+
<div class="method_details first">
|
|
586
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
587
|
+
|
|
588
|
+
#<strong>initialize</strong>(direction:, path:, total_bytes:, completed_bytes:, local_path: nil, source: nil, sink: nil, version: nil, state: {}) ⇒ <tt><span class='object_link'><a href="" title="Files::Transfer::Checkpoint (class)">Checkpoint</a></span></tt>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</h3><div class="docstring">
|
|
595
|
+
<div class="discussion">
|
|
596
|
+
<p>Returns a new instance of Checkpoint.</p>
|
|
597
|
+
|
|
598
|
+
</div>
|
|
599
|
+
</div>
|
|
600
|
+
<div class="tags">
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
</div><table class="source_code">
|
|
604
|
+
<tr>
|
|
605
|
+
<td>
|
|
606
|
+
<pre class="lines">
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
57
|
|
610
|
+
58
|
|
611
|
+
59
|
|
612
|
+
60
|
|
613
|
+
61
|
|
614
|
+
62
|
|
615
|
+
63
|
|
616
|
+
64
|
|
617
|
+
65
|
|
618
|
+
66
|
|
619
|
+
67
|
|
620
|
+
68
|
|
621
|
+
69
|
|
622
|
+
70
|
|
623
|
+
71</pre>
|
|
624
|
+
</td>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 57</span>
|
|
627
|
+
|
|
628
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>direction:</span><span class='comma'>,</span> <span class='label'>path:</span><span class='comma'>,</span> <span class='label'>total_bytes:</span><span class='comma'>,</span> <span class='label'>completed_bytes:</span><span class='comma'>,</span> <span class='label'>local_path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>source:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sink:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>version:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>state:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
629
|
+
<span class='ivar'>@process</span> <span class='op'>=</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_pid'>pid</span>
|
|
630
|
+
<span class='ivar'>@direction</span> <span class='op'>=</span> <span class='id identifier rubyid_direction'>direction</span>
|
|
631
|
+
<span class='ivar'>@path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
632
|
+
<span class='ivar'>@local_path</span> <span class='op'>=</span> <span class='id identifier rubyid_local_path'>local_path</span><span class='op'>&.</span><span class='id identifier rubyid_dup'>dup</span><span class='op'>&.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
633
|
+
<span class='ivar'>@total_bytes</span> <span class='op'>=</span> <span class='id identifier rubyid_total_bytes'>total_bytes</span>
|
|
634
|
+
<span class='ivar'>@completed_bytes</span> <span class='op'>=</span> <span class='id identifier rubyid_completed_bytes'>completed_bytes</span>
|
|
635
|
+
<span class='ivar'>@source</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Files::Transfer::Checkpoint (class)">Checkpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_frozen'><span class='object_link'><a href="#frozen-class_method" title="Files::Transfer::Checkpoint.frozen (method)">frozen</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span>
|
|
636
|
+
<span class='ivar'>@sink</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Files::Transfer::Checkpoint (class)">Checkpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_frozen'><span class='object_link'><a href="#frozen-class_method" title="Files::Transfer::Checkpoint.frozen (method)">frozen</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sink'>sink</span><span class='rparen'>)</span>
|
|
637
|
+
<span class='ivar'>@version</span> <span class='op'>=</span> <span class='id identifier rubyid_version'>version</span><span class='op'>&.</span><span class='id identifier rubyid_dup'>dup</span><span class='op'>&.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
638
|
+
<span class='ivar'>@state</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Files::Transfer::Checkpoint (class)">Checkpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_frozen'><span class='object_link'><a href="#frozen-class_method" title="Files::Transfer::Checkpoint.frozen (method)">frozen</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
|
|
639
|
+
<span class='ivar'>@hold_lock</span> <span class='op'>=</span> <span class='const'>Mutex</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
640
|
+
<span class='ivar'>@hold</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='symbol'>:ready</span> <span class='rbracket'>]</span>
|
|
641
|
+
<span class='id identifier rubyid_freeze'>freeze</span>
|
|
642
|
+
<span class='kw'>end</span></pre>
|
|
643
|
+
</td>
|
|
644
|
+
</tr>
|
|
645
|
+
</table>
|
|
646
|
+
</div>
|
|
647
|
+
|
|
648
|
+
</div>
|
|
649
|
+
|
|
650
|
+
<div id="instance_attr_details" class="attr_details">
|
|
651
|
+
<h2>Instance Attribute Details</h2>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<span id=""></span>
|
|
655
|
+
<div class="method_details first">
|
|
656
|
+
<h3 class="signature first" id="completed_bytes-instance_method">
|
|
657
|
+
|
|
658
|
+
#<strong>completed_bytes</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
</h3><div class="docstring">
|
|
665
|
+
<div class="discussion">
|
|
666
|
+
<p>Returns the value of attribute completed_bytes.</p>
|
|
667
|
+
|
|
668
|
+
</div>
|
|
669
|
+
</div>
|
|
670
|
+
<div class="tags">
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</div><table class="source_code">
|
|
674
|
+
<tr>
|
|
675
|
+
<td>
|
|
676
|
+
<pre class="lines">
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
38
|
|
680
|
+
39
|
|
681
|
+
40</pre>
|
|
682
|
+
</td>
|
|
683
|
+
<td>
|
|
684
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
685
|
+
|
|
686
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_completed_bytes'>completed_bytes</span>
|
|
687
|
+
<span class='ivar'>@completed_bytes</span>
|
|
688
|
+
<span class='kw'>end</span></pre>
|
|
689
|
+
</td>
|
|
690
|
+
</tr>
|
|
691
|
+
</table>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
<span id=""></span>
|
|
696
|
+
<div class="method_details ">
|
|
697
|
+
<h3 class="signature " id="direction-instance_method">
|
|
698
|
+
|
|
699
|
+
#<strong>direction</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
</h3><div class="docstring">
|
|
706
|
+
<div class="discussion">
|
|
707
|
+
<p>Returns the value of attribute direction.</p>
|
|
708
|
+
|
|
709
|
+
</div>
|
|
710
|
+
</div>
|
|
711
|
+
<div class="tags">
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
</div><table class="source_code">
|
|
715
|
+
<tr>
|
|
716
|
+
<td>
|
|
717
|
+
<pre class="lines">
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
38
|
|
721
|
+
39
|
|
722
|
+
40</pre>
|
|
723
|
+
</td>
|
|
724
|
+
<td>
|
|
725
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
726
|
+
|
|
727
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_direction'>direction</span>
|
|
728
|
+
<span class='ivar'>@direction</span>
|
|
729
|
+
<span class='kw'>end</span></pre>
|
|
730
|
+
</td>
|
|
731
|
+
</tr>
|
|
732
|
+
</table>
|
|
733
|
+
</div>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
<span id=""></span>
|
|
737
|
+
<div class="method_details ">
|
|
738
|
+
<h3 class="signature " id="local_path-instance_method">
|
|
739
|
+
|
|
740
|
+
#<strong>local_path</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
</h3><div class="docstring">
|
|
747
|
+
<div class="discussion">
|
|
748
|
+
<p>Returns the value of attribute local_path.</p>
|
|
749
|
+
|
|
750
|
+
</div>
|
|
751
|
+
</div>
|
|
752
|
+
<div class="tags">
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
</div><table class="source_code">
|
|
756
|
+
<tr>
|
|
757
|
+
<td>
|
|
758
|
+
<pre class="lines">
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
38
|
|
762
|
+
39
|
|
763
|
+
40</pre>
|
|
764
|
+
</td>
|
|
765
|
+
<td>
|
|
766
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
767
|
+
|
|
768
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_local_path'>local_path</span>
|
|
769
|
+
<span class='ivar'>@local_path</span>
|
|
770
|
+
<span class='kw'>end</span></pre>
|
|
771
|
+
</td>
|
|
772
|
+
</tr>
|
|
773
|
+
</table>
|
|
774
|
+
</div>
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
<span id=""></span>
|
|
778
|
+
<div class="method_details ">
|
|
779
|
+
<h3 class="signature " id="path-instance_method">
|
|
780
|
+
|
|
781
|
+
#<strong>path</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</h3><div class="docstring">
|
|
788
|
+
<div class="discussion">
|
|
789
|
+
<p>Returns the value of attribute path.</p>
|
|
790
|
+
|
|
791
|
+
</div>
|
|
792
|
+
</div>
|
|
793
|
+
<div class="tags">
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
</div><table class="source_code">
|
|
797
|
+
<tr>
|
|
798
|
+
<td>
|
|
799
|
+
<pre class="lines">
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
38
|
|
803
|
+
39
|
|
804
|
+
40</pre>
|
|
805
|
+
</td>
|
|
806
|
+
<td>
|
|
807
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
808
|
+
|
|
809
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
|
|
810
|
+
<span class='ivar'>@path</span>
|
|
811
|
+
<span class='kw'>end</span></pre>
|
|
812
|
+
</td>
|
|
813
|
+
</tr>
|
|
814
|
+
</table>
|
|
815
|
+
</div>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
<span id=""></span>
|
|
819
|
+
<div class="method_details ">
|
|
820
|
+
<h3 class="signature " id="sink-instance_method">
|
|
821
|
+
|
|
822
|
+
#<strong>sink</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
</h3><div class="docstring">
|
|
829
|
+
<div class="discussion">
|
|
830
|
+
<p>Returns the value of attribute sink.</p>
|
|
831
|
+
|
|
832
|
+
</div>
|
|
833
|
+
</div>
|
|
834
|
+
<div class="tags">
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
</div><table class="source_code">
|
|
838
|
+
<tr>
|
|
839
|
+
<td>
|
|
840
|
+
<pre class="lines">
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
38
|
|
844
|
+
39
|
|
845
|
+
40</pre>
|
|
846
|
+
</td>
|
|
847
|
+
<td>
|
|
848
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
849
|
+
|
|
850
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sink'>sink</span>
|
|
851
|
+
<span class='ivar'>@sink</span>
|
|
852
|
+
<span class='kw'>end</span></pre>
|
|
853
|
+
</td>
|
|
854
|
+
</tr>
|
|
855
|
+
</table>
|
|
856
|
+
</div>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<span id=""></span>
|
|
860
|
+
<div class="method_details ">
|
|
861
|
+
<h3 class="signature " id="source-instance_method">
|
|
862
|
+
|
|
863
|
+
#<strong>source</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
</h3><div class="docstring">
|
|
870
|
+
<div class="discussion">
|
|
871
|
+
<p>Returns the value of attribute source.</p>
|
|
872
|
+
|
|
873
|
+
</div>
|
|
874
|
+
</div>
|
|
875
|
+
<div class="tags">
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
</div><table class="source_code">
|
|
879
|
+
<tr>
|
|
880
|
+
<td>
|
|
881
|
+
<pre class="lines">
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
38
|
|
885
|
+
39
|
|
886
|
+
40</pre>
|
|
887
|
+
</td>
|
|
888
|
+
<td>
|
|
889
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
890
|
+
|
|
891
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_source'>source</span>
|
|
892
|
+
<span class='ivar'>@source</span>
|
|
893
|
+
<span class='kw'>end</span></pre>
|
|
894
|
+
</td>
|
|
895
|
+
</tr>
|
|
896
|
+
</table>
|
|
897
|
+
</div>
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
<span id=""></span>
|
|
901
|
+
<div class="method_details ">
|
|
902
|
+
<h3 class="signature " id="state-instance_method">
|
|
903
|
+
|
|
904
|
+
#<strong>state</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</h3><div class="docstring">
|
|
911
|
+
<div class="discussion">
|
|
912
|
+
<p>Returns the value of attribute state.</p>
|
|
913
|
+
|
|
914
|
+
</div>
|
|
915
|
+
</div>
|
|
916
|
+
<div class="tags">
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
</div><table class="source_code">
|
|
920
|
+
<tr>
|
|
921
|
+
<td>
|
|
922
|
+
<pre class="lines">
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
38
|
|
926
|
+
39
|
|
927
|
+
40</pre>
|
|
928
|
+
</td>
|
|
929
|
+
<td>
|
|
930
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
931
|
+
|
|
932
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
|
|
933
|
+
<span class='ivar'>@state</span>
|
|
934
|
+
<span class='kw'>end</span></pre>
|
|
935
|
+
</td>
|
|
936
|
+
</tr>
|
|
937
|
+
</table>
|
|
938
|
+
</div>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<span id=""></span>
|
|
942
|
+
<div class="method_details ">
|
|
943
|
+
<h3 class="signature " id="total_bytes-instance_method">
|
|
944
|
+
|
|
945
|
+
#<strong>total_bytes</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
</h3><div class="docstring">
|
|
952
|
+
<div class="discussion">
|
|
953
|
+
<p>Returns the value of attribute total_bytes.</p>
|
|
954
|
+
|
|
955
|
+
</div>
|
|
956
|
+
</div>
|
|
957
|
+
<div class="tags">
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
</div><table class="source_code">
|
|
961
|
+
<tr>
|
|
962
|
+
<td>
|
|
963
|
+
<pre class="lines">
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
38
|
|
967
|
+
39
|
|
968
|
+
40</pre>
|
|
969
|
+
</td>
|
|
970
|
+
<td>
|
|
971
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
972
|
+
|
|
973
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_total_bytes'>total_bytes</span>
|
|
974
|
+
<span class='ivar'>@total_bytes</span>
|
|
975
|
+
<span class='kw'>end</span></pre>
|
|
976
|
+
</td>
|
|
977
|
+
</tr>
|
|
978
|
+
</table>
|
|
979
|
+
</div>
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
<span id=""></span>
|
|
983
|
+
<div class="method_details ">
|
|
984
|
+
<h3 class="signature " id="version-instance_method">
|
|
985
|
+
|
|
986
|
+
#<strong>version</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
</h3><div class="docstring">
|
|
993
|
+
<div class="discussion">
|
|
994
|
+
<p>Returns the value of attribute version.</p>
|
|
995
|
+
|
|
996
|
+
</div>
|
|
997
|
+
</div>
|
|
998
|
+
<div class="tags">
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
</div><table class="source_code">
|
|
1002
|
+
<tr>
|
|
1003
|
+
<td>
|
|
1004
|
+
<pre class="lines">
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
38
|
|
1008
|
+
39
|
|
1009
|
+
40</pre>
|
|
1010
|
+
</td>
|
|
1011
|
+
<td>
|
|
1012
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 38</span>
|
|
1013
|
+
|
|
1014
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_version'>version</span>
|
|
1015
|
+
<span class='ivar'>@version</span>
|
|
1016
|
+
<span class='kw'>end</span></pre>
|
|
1017
|
+
</td>
|
|
1018
|
+
</tr>
|
|
1019
|
+
</table>
|
|
1020
|
+
</div>
|
|
1021
|
+
|
|
1022
|
+
</div>
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
<div id="class_method_details" class="method_details_list">
|
|
1026
|
+
<h2>Class Method Details</h2>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
<div class="method_details first">
|
|
1030
|
+
<h3 class="signature first" id="frozen-class_method">
|
|
1031
|
+
|
|
1032
|
+
.<strong>frozen</strong>(value) ⇒ <tt>Object</tt>
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
</h3><div class="docstring">
|
|
1039
|
+
<div class="discussion">
|
|
1040
|
+
<p>A frozen copy of value's Hashes, Arrays and Strings, all the way down. Anything else, such as a caller's IO, is
|
|
1041
|
+
kept as it is.</p>
|
|
1042
|
+
|
|
1043
|
+
</div>
|
|
1044
|
+
</div>
|
|
1045
|
+
<div class="tags">
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
</div><table class="source_code">
|
|
1049
|
+
<tr>
|
|
1050
|
+
<td>
|
|
1051
|
+
<pre class="lines">
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
48
|
|
1055
|
+
49
|
|
1056
|
+
50
|
|
1057
|
+
51
|
|
1058
|
+
52
|
|
1059
|
+
53
|
|
1060
|
+
54
|
|
1061
|
+
55</pre>
|
|
1062
|
+
</td>
|
|
1063
|
+
<td>
|
|
1064
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 48</span>
|
|
1065
|
+
|
|
1066
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_frozen'>frozen</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
1067
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
|
|
1068
|
+
<span class='kw'>when</span> <span class='const'>Hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_item'>item</span><span class='op'>|</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_frozen'>frozen</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_frozen'>frozen</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
1069
|
+
<span class='kw'>when</span> <span class='const'>Array</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span> <span class='id identifier rubyid_frozen'>frozen</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
1070
|
+
<span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_frozen?'>frozen?</span> <span class='op'>?</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>:</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
1071
|
+
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
|
|
1072
|
+
<span class='kw'>end</span>
|
|
1073
|
+
<span class='kw'>end</span></pre>
|
|
1074
|
+
</td>
|
|
1075
|
+
</tr>
|
|
1076
|
+
</table>
|
|
1077
|
+
</div>
|
|
1078
|
+
|
|
1079
|
+
<div class="method_details ">
|
|
1080
|
+
<h3 class="signature " id="identity-class_method">
|
|
1081
|
+
|
|
1082
|
+
.<strong>identity</strong>(stat, contents: true) ⇒ <tt>Object</tt>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
</h3><div class="docstring">
|
|
1089
|
+
<div class="discussion">
|
|
1090
|
+
<p>The identity of an opened local file, from its stat: [device, inode], with size and modification time unless
|
|
1091
|
+
contents is false.</p>
|
|
1092
|
+
|
|
1093
|
+
</div>
|
|
1094
|
+
</div>
|
|
1095
|
+
<div class="tags">
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
</div><table class="source_code">
|
|
1099
|
+
<tr>
|
|
1100
|
+
<td>
|
|
1101
|
+
<pre class="lines">
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
42
|
|
1105
|
+
43
|
|
1106
|
+
44</pre>
|
|
1107
|
+
</td>
|
|
1108
|
+
<td>
|
|
1109
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 42</span>
|
|
1110
|
+
|
|
1111
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_identity'>identity</span><span class='lparen'>(</span><span class='id identifier rubyid_stat'>stat</span><span class='comma'>,</span> <span class='label'>contents:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1112
|
+
<span class='id identifier rubyid_contents'>contents</span> <span class='op'>?</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_dev'>dev</span><span class='comma'>,</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_ino'>ino</span><span class='comma'>,</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='comma'>,</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_mtime'>mtime</span><span class='period'>.</span><span class='id identifier rubyid_to_r'>to_r</span> <span class='rbracket'>]</span> <span class='op'>:</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_dev'>dev</span><span class='comma'>,</span> <span class='id identifier rubyid_stat'>stat</span><span class='period'>.</span><span class='id identifier rubyid_ino'>ino</span> <span class='rbracket'>]</span>
|
|
1113
|
+
<span class='kw'>end</span></pre>
|
|
1114
|
+
</td>
|
|
1115
|
+
</tr>
|
|
1116
|
+
</table>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</div>
|
|
1120
|
+
|
|
1121
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1122
|
+
<h2>Instance Method Details</h2>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
<div class="method_details first">
|
|
1126
|
+
<h3 class="signature first" id="inspect-instance_method">
|
|
1127
|
+
|
|
1128
|
+
#<strong>inspect</strong> ⇒ <tt>Object</tt>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
</h3><table class="source_code">
|
|
1135
|
+
<tr>
|
|
1136
|
+
<td>
|
|
1137
|
+
<pre class="lines">
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
100
|
|
1141
|
+
101
|
|
1142
|
+
102</pre>
|
|
1143
|
+
</td>
|
|
1144
|
+
<td>
|
|
1145
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 100</span>
|
|
1146
|
+
|
|
1147
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
|
|
1148
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@direction</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@path</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@completed_bytes</span><span class='embexpr_end'>}</span><span class='tstring_content'> of </span><span class='embexpr_beg'>#{</span><span class='ivar'>@total_bytes</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> bytes></span><span class='tstring_end'>"</span></span>
|
|
1149
|
+
<span class='kw'>end</span></pre>
|
|
1150
|
+
</td>
|
|
1151
|
+
</tr>
|
|
1152
|
+
</table>
|
|
1153
|
+
</div>
|
|
1154
|
+
|
|
1155
|
+
<div class="method_details ">
|
|
1156
|
+
<h3 class="signature " id="marshal_dump-instance_method">
|
|
1157
|
+
|
|
1158
|
+
#<strong>marshal_dump</strong> ⇒ <tt>Object</tt>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
</h3><div class="docstring">
|
|
1165
|
+
<div class="discussion">
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
</div>
|
|
1169
|
+
</div>
|
|
1170
|
+
<div class="tags">
|
|
1171
|
+
|
|
1172
|
+
<p class="tag_title">Raises:</p>
|
|
1173
|
+
<ul class="raise">
|
|
1174
|
+
|
|
1175
|
+
<li>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
<span class='type'>(<tt>TypeError</tt>)</span>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
</li>
|
|
1183
|
+
|
|
1184
|
+
</ul>
|
|
1185
|
+
|
|
1186
|
+
</div><table class="source_code">
|
|
1187
|
+
<tr>
|
|
1188
|
+
<td>
|
|
1189
|
+
<pre class="lines">
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
108
|
|
1193
|
+
109
|
|
1194
|
+
110</pre>
|
|
1195
|
+
</td>
|
|
1196
|
+
<td>
|
|
1197
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 108</span>
|
|
1198
|
+
|
|
1199
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_marshal_dump'>marshal_dump</span>
|
|
1200
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>a Files::Transfer::Checkpoint resumes only in the process that paused it, so it cannot be dumped</span><span class='tstring_end'>"</span></span>
|
|
1201
|
+
<span class='kw'>end</span></pre>
|
|
1202
|
+
</td>
|
|
1203
|
+
</tr>
|
|
1204
|
+
</table>
|
|
1205
|
+
</div>
|
|
1206
|
+
|
|
1207
|
+
<div class="method_details ">
|
|
1208
|
+
<h3 class="signature " id="resuming-instance_method">
|
|
1209
|
+
|
|
1210
|
+
#<strong>resuming</strong>(direction) ⇒ <tt>Object</tt>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
</h3><div class="docstring">
|
|
1217
|
+
<div class="discussion">
|
|
1218
|
+
<p>Runs the block, which resumes the transfer in direction, as the one resume holding this checkpoint, and returns
|
|
1219
|
+
what it returns. The block gets the resume's lease and calls its start! once its checks pass, before it sends,
|
|
1220
|
+
writes or truncates anything; from then on the checkpoint is spent, whatever happens. Raises CheckpointError as
|
|
1221
|
+
verify! does, while another resume holds it, and once it is spent.</p>
|
|
1222
|
+
|
|
1223
|
+
</div>
|
|
1224
|
+
</div>
|
|
1225
|
+
<div class="tags">
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</div><table class="source_code">
|
|
1229
|
+
<tr>
|
|
1230
|
+
<td>
|
|
1231
|
+
<pre class="lines">
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
83
|
|
1235
|
+
84
|
|
1236
|
+
85
|
|
1237
|
+
86
|
|
1238
|
+
87
|
|
1239
|
+
88
|
|
1240
|
+
89
|
|
1241
|
+
90
|
|
1242
|
+
91
|
|
1243
|
+
92
|
|
1244
|
+
93
|
|
1245
|
+
94
|
|
1246
|
+
95
|
|
1247
|
+
96
|
|
1248
|
+
97
|
|
1249
|
+
98</pre>
|
|
1250
|
+
</td>
|
|
1251
|
+
<td>
|
|
1252
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 83</span>
|
|
1253
|
+
|
|
1254
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resuming'>resuming</span><span class='lparen'>(</span><span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
|
|
1255
|
+
<span class='id identifier rubyid_verify!'>verify!</span><span class='lparen'>(</span><span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
|
|
1256
|
+
<span class='id identifier rubyid_lease'>lease</span> <span class='op'>=</span> <span class='const'>Lease</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
1257
|
+
<span class='ivar'>@hold_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
|
|
1258
|
+
<span class='kw'>case</span> <span class='ivar'>@hold</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1259
|
+
<span class='kw'>when</span> <span class='const'>Lease</span> <span class='kw'>then</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CheckpointError.html" title="Files::Transfer::CheckpointError (class)">CheckpointError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: another resume is already using this checkpoint</span><span class='tstring_end'>"</span></span>
|
|
1260
|
+
<span class='kw'>when</span> <span class='symbol'>:spent</span> <span class='kw'>then</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CheckpointError.html" title="Files::Transfer::CheckpointError (class)">CheckpointError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: this checkpoint has already been used to resume its transfer; resume from the checkpoint its own pause gave</span><span class='tstring_end'>"</span></span>
|
|
1261
|
+
<span class='kw'>end</span>
|
|
1262
|
+
<span class='ivar'>@hold</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_lease'>lease</span>
|
|
1263
|
+
<span class='kw'>end</span>
|
|
1264
|
+
<span class='kw'>begin</span>
|
|
1265
|
+
<span class='kw'>yield</span> <span class='id identifier rubyid_lease'>lease</span>
|
|
1266
|
+
<span class='kw'>ensure</span>
|
|
1267
|
+
<span class='ivar'>@hold_lock</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span> <span class='ivar'>@hold</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_lease'>lease</span><span class='period'>.</span><span class='id identifier rubyid_started?'>started?</span> <span class='op'>?</span> <span class='symbol'>:spent</span> <span class='op'>:</span> <span class='symbol'>:ready</span> <span class='rbrace'>}</span>
|
|
1268
|
+
<span class='kw'>end</span>
|
|
1269
|
+
<span class='kw'>end</span></pre>
|
|
1270
|
+
</td>
|
|
1271
|
+
</tr>
|
|
1272
|
+
</table>
|
|
1273
|
+
</div>
|
|
1274
|
+
|
|
1275
|
+
<div class="method_details ">
|
|
1276
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
1277
|
+
|
|
1278
|
+
#<strong>to_s</strong> ⇒ <tt>Object</tt>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
</h3><table class="source_code">
|
|
1285
|
+
<tr>
|
|
1286
|
+
<td>
|
|
1287
|
+
<pre class="lines">
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
104
|
|
1291
|
+
105
|
|
1292
|
+
106</pre>
|
|
1293
|
+
</td>
|
|
1294
|
+
<td>
|
|
1295
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 104</span>
|
|
1296
|
+
|
|
1297
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
|
1298
|
+
<span class='id identifier rubyid_inspect'>inspect</span>
|
|
1299
|
+
<span class='kw'>end</span></pre>
|
|
1300
|
+
</td>
|
|
1301
|
+
</tr>
|
|
1302
|
+
</table>
|
|
1303
|
+
</div>
|
|
1304
|
+
|
|
1305
|
+
<div class="method_details ">
|
|
1306
|
+
<h3 class="signature " id="verify!-instance_method">
|
|
1307
|
+
|
|
1308
|
+
#<strong>verify!</strong>(direction) ⇒ <tt>Object</tt>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
</h3><div class="docstring">
|
|
1315
|
+
<div class="discussion">
|
|
1316
|
+
<p>Raises CheckpointError unless this checkpoint can resume a transfer in direction (:upload or :download).</p>
|
|
1317
|
+
|
|
1318
|
+
</div>
|
|
1319
|
+
</div>
|
|
1320
|
+
<div class="tags">
|
|
1321
|
+
|
|
1322
|
+
<p class="tag_title">Raises:</p>
|
|
1323
|
+
<ul class="raise">
|
|
1324
|
+
|
|
1325
|
+
<li>
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<span class='type'>(<tt><span class='object_link'><a href="CheckpointError.html" title="Files::Transfer::CheckpointError (class)">CheckpointError</a></span></tt>)</span>
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
</li>
|
|
1333
|
+
|
|
1334
|
+
</ul>
|
|
1335
|
+
|
|
1336
|
+
</div><table class="source_code">
|
|
1337
|
+
<tr>
|
|
1338
|
+
<td>
|
|
1339
|
+
<pre class="lines">
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
74
|
|
1343
|
+
75
|
|
1344
|
+
76
|
|
1345
|
+
77</pre>
|
|
1346
|
+
</td>
|
|
1347
|
+
<td>
|
|
1348
|
+
<pre class="code"><span class="info file"># File 'lib/files.com/transfer/checkpoint.rb', line 74</span>
|
|
1349
|
+
|
|
1350
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_verify!'>verify!</span><span class='lparen'>(</span><span class='id identifier rubyid_direction'>direction</span><span class='rparen'>)</span>
|
|
1351
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CheckpointError.html" title="Files::Transfer::CheckpointError (class)">CheckpointError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: a transfer checkpoint resumes only in the process that paused it</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@process</span> <span class='op'>==</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_pid'>pid</span>
|
|
1352
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="CheckpointError.html" title="Files::Transfer::CheckpointError (class)">CheckpointError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad parameter: this checkpoint resumes </span><span class='embexpr_beg'>#{</span><span class='ivar'>@direction</span> <span class='op'>==</span> <span class='symbol'>:upload</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>an upload</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a download</span><span class='tstring_end'>'</span></span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@direction</span> <span class='op'>==</span> <span class='id identifier rubyid_direction'>direction</span>
|
|
1353
|
+
<span class='kw'>end</span></pre>
|
|
1354
|
+
</td>
|
|
1355
|
+
</tr>
|
|
1356
|
+
</table>
|
|
1357
|
+
</div>
|
|
1358
|
+
|
|
1359
|
+
</div>
|
|
1360
|
+
|
|
1361
|
+
</div>
|
|
1362
|
+
|
|
1363
|
+
<div id="footer">
|
|
1364
|
+
Generated on Tue Nov 3 21:11:59 2026 by
|
|
1365
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1366
|
+
0.9.45 (ruby-4.0.9).
|
|
1367
|
+
</div>
|
|
1368
|
+
|
|
1369
|
+
</div>
|
|
1370
|
+
</body>
|
|
1371
|
+
</html>
|