QLockFile Class

멤버 함수 문서

[explicit] QLockFile::QLockFile(const QString &fileName)

새로운 잠금 파일 객체를 생성합니다. 이 객체는 잠금 해제된 상태로 생성됩니다. ` lock()` 또는 ` tryLock()`를 호출하면, ` fileName `이라는 이름의 잠금 파일이 아직 존재하지 않을 경우 생성됩니다.

lock() 및 unlock()도 참조하십시오 .

[noexcept] QLockFile::~QLockFile()

잠금 파일 객체를 삭제합니다. 잠금이 획득된 상태라면, 이 메서드는 잠금 파일을 삭제하여 잠금을 해제합니다.

QLockFile::LockError QLockFile::error() const

잠금 파일의 오류 상태를 반환합니다.

tryLock()가 false 를 반환하는 경우, 이 함수를 호출하여 잠금 실패의 원인을 확인할 수 있습니다.

QString QLockFile::fileName() const

잠금 파일의 파일 이름을 반환합니다.

bool QLockFile::getLockInfo(qint64 *pid, QString *hostname, QString *appname) const

잠금 파일의 현재 소유자에 대한 정보를 가져옵니다.

tryLock()가 false 를 반환하고, error()가 LockFailedError 를 반환하는 경우, 이 함수를 호출하여 기존 잠금 파일에 대한 추가 정보를 확인할 수 있습니다:

• 애플리케이션의 PID ( pid 에서 반환됨)
• 해당 애플리케이션이 실행 중인 hostname (네트워크 파일 시스템의 경우 유용함),
• 해당 파일을 생성한 애플리케이션의 이름( appname 에서 반환됨),

tryLock()는 해당 PID를 가진 실행 중인 애플리케이션이 없으면 파일을 자동으로 삭제하므로, LockFailedError 는 해당 PID를 가진 애플리케이션이 있을 때만 호출될 수 있습니다(비록 관련이 없을 수도 있지만).

이를 통해 사용자에게 기존 잠금 파일의 존재를 알리고, 파일을 삭제할지 여부를 선택할 수 있도록 할 수 있습니다. removeStaleLockFile()를 사용하여 파일을 제거한 후, 애플리케이션은 tryLock()를 다시 호출할 수 있습니다.

이 함수는 정보를 성공적으로 가져올 수 있으면 true 를 반환하고, 잠금 파일이 존재하지 않거나 예상된 데이터를 포함하지 않으면 false를 반환합니다. 이는 tryLock() 호출이 실패한 시점과 이 함수를 호출하는 시점 사이에 잠금 파일이 삭제된 경우에 발생할 수 있습니다. 이 경우 tryLock()를 다시 호출하기만 하면 됩니다.

bool QLockFile::isLocked() const

이 QLockFile 인스턴스가 잠금을 획득한 경우 true 을 반환하고, 그렇지 않은 경우 false 을 반환합니다.

lock(), unlock(), tryLock()도 참조하십시오 .

bool QLockFile::lock()

잠금 파일을 생성합니다.

다른 프로세스(또는 다른 스레드)가 이미 잠금 파일을 생성한 경우, 이 함수는 해당 프로세스(또는 스레드)가 잠금을 해제할 때까지 차단됩니다.

먼저 잠금을 해제하지 않고 동일한 스레드에서 동일한 잠금에 대해 이 함수를 여러 번 호출하는 것은 허용되지 않습니다. 파일이 재귀적으로 잠겨 있는 경우 이 함수는 데드락 상태에 빠집니다.

잠금이 획득된 경우 ` true `를 반환하고, 상위 디렉터리에 권한이 없는 등 복구 불가능한 오류로 인해 잠금을 획득할 수 없는 경우 `false`를 반환합니다.

unlock() 및 tryLock()도 참조하십시오 .

bool QLockFile::removeStaleLockFile()

기존 잠금 파일을 강제로 제거하려는 시도입니다.

단기적인 작업을 보호할 때는 이 함수를 호출하지 않는 것이 좋습니다. ` QLockFile ` 함수는 이미 ` staleLockTime()`보다 오래된 잠금 파일을 자동으로 제거해 주기 때문입니다.

이 메서드는 리소스를 장기간 보호하는 경우, 즉 ` staleLockTime(0)`을 사용하는 경우에만 호출해야 하며, ` tryLock()`가 ` LockFailedError`를 반환한 후 사용자가 잠금 파일 제거에 동의한 경우에 한해 호출해야 합니다.

성공 시 true 를 반환하고, 잠금 파일을 제거할 수 없는 경우 false를 반환합니다. 이는 Windows에서 잠금을 소유한 애플리케이션이 여전히 실행 중일 때 발생합니다.

void QLockFile::setStaleLockTime(int staleLockTime)

staleLockTime 를 잠금 파일이 유효하지 않은 것으로 간주되기까지의 시간(밀리초 단위)으로 설정합니다. 기본값은 30000, 즉 30초입니다. 애플리케이션에서 일반적으로 파일을 30초 이상 잠그고 있는 경우(예: 2분 동안 메가바이트 단위의 데이터를 저장하는 경우), setStaleLockTime()을 사용하여 더 큰 값을 설정해야 합니다.

staleLockTime 의 값은 lock() 및 tryLock()에서 기존 잠금 파일이 언제 '유효 기간이 만료된' 것으로 간주될지, 즉 중단된 프로세스에 의해 남겨진 것으로 간주될지를 결정하는 데 사용됩니다. 이는 그 사이 PID가 재사용된 경우에 유용하며, 따라서 유효 기간이 만료된 잠금 파일을 감지하는 한 가지 방법은 해당 파일이 오랫동안 존재해 왔다는 사실입니다.

이 함수는 오버로드된 함수로, 다음 호출과 동일합니다:

setStaleLockTime(std::chrono::milliseconds{staleLockTime});

staleLockTime()도 참조하십시오 .

[since 6.2] void QLockFile::setStaleLockTime(std::chrono::milliseconds staleLockTime)

잠금 파일이 유효하지 않은 것으로 간주되는 간격을 ` staleLockTime`로 설정합니다. 기본값은 30초입니다.

애플리케이션이 일반적으로 30초 이상 파일을 잠그고 있는 경우(예: 2분 동안 메가바이트 단위의 데이터를 저장하는 경우), setStaleLockTime()을 사용하여 더 큰 값을 설정해야 합니다.

staleLockTime()의 값은 lock() 및 tryLock()에서 기존 잠금 파일이 언제 유효하지 않은 것으로 간주될지(즉, 중단된 프로세스가 남긴 잔여물인지) 판단하는 데 사용됩니다. 이는 그 사이 PID가 재사용된 경우에 유용하며, 유효하지 않은 잠금 파일을 탐지하는 한 가지 방법은 파일이 오랫동안 존재해 왔다는 사실입니다.

이 값을 0 또는 음수로 설정하면 잠금 파일의 타임스탬프 검증이 비활성화됩니다. QLockFile 는 파일 내용이 잠금을 설정했던 프로세스가 더 이상 실행 중이지 않음을 나타내는 경우, 여전히 오래된 잠금 파일을 감지합니다.

이 함수는 Qt 6.2에서 도입되었습니다.

staleLockTime()도 참조하십시오 .

int QLockFile::staleLockTime() const

잠금 파일이 더 이상 유효하지 않은 것으로 간주되기까지의 시간을 밀리초 단위로 반환합니다.

setStaleLockTime()도 참조하십시오 .

[since 6.2] std::chrono::milliseconds QLockFile::staleLockTimeAsDuration() const

잠금 파일이 유효하지 않은 것으로 간주되는 시점을 나타내는 std::chrono::milliseconds 객체를 반환합니다.

이 함수는 Qt 6.2에서 도입되었습니다.

setStaleLockTime()도 참조하십시오 .

bool QLockFile::tryLock(int timeout)

잠금 파일을 생성하려고 시도합니다. 이 함수는 잠금을 획득한 경우 ` true `를 반환하고, 그렇지 않은 경우 ` false`를 반환합니다. 다른 프로세스(또는 다른 스레드)가 이미 잠금 파일을 생성한 경우, 이 함수는 잠금 파일이 사용 가능해질 때까지 최대 ` timeout ` 밀리초 동안 대기합니다.

참고: timeout 매개변수로 음수를 전달하는 것은 lock()를 호출하는 것과 동일합니다. 즉, timeout 가 음수인 경우 이 함수는 잠금 파일을 잠글 수 있을 때까지 무한정 대기합니다.

잠금이 획득된 경우, 다른 프로세스(또는 스레드)가 해당 파일을 성공적으로 잠글 수 있으려면 unlock()을 사용하여 잠금을 해제해야 합니다.

먼저 잠금을 해제하지 않고 동일한 스레드에서 동일한 잠금에 대해 이 함수를 여러 번 호출하는 것은 허용되지 않으며, 파일을 재귀적으로 잠그려고 할 때 이 함수는 항상 false를 반환합니다.

lock() 및 unlock()도 참조하십시오 .

[since 6.2] bool QLockFile::tryLock(std::chrono::milliseconds timeout = std::chrono::milliseconds::zero())

잠금 파일을 생성하려고 시도합니다. 이 함수는 잠금을 획득한 경우 ` true `를 반환하고, 그렇지 않은 경우 ` false`를 반환합니다. 다른 프로세스(또는 다른 스레드)가 이미 잠금 파일을 생성한 경우, 이 함수는 잠금 파일이 사용 가능해질 때까지 최대 ` timeout ` 동안 대기합니다.

잠금을 획득한 경우, 다른 프로세스(또는 스레드)가 해당 파일을 성공적으로 잠글 수 있도록 하기 전에 unlock()을 사용하여 잠금을 해제해야 합니다.

먼저 잠금을 해제하지 않고 동일한 스레드에서 동일한 잠금에 대해 이 함수를 여러 번 호출하는 것은 허용되지 않으며, 파일을 재귀적으로 잠그려고 시도할 때 이 함수는 항상 false를 반환합니다.

이 함수는 Qt 6.2에서 도입되었습니다.

lock() 및 unlock()도 참조하십시오 .

void QLockFile::unlock()

잠금 파일을 삭제하여 잠금을 해제합니다.

파일을 먼저 잠그지 않은 상태에서 unlock()을 호출하면 아무런 동작도 수행되지 않습니다.

lock() 및 tryLock()도 참조하십시오 .