/ 
Net-Gnats-0.22
River stage zero No dependents
/ Net::Gnats::Command::LOCK

NAME

Net::Gnats::Command::LOCK

DESCRIPTION

Locks the specified PR, marking the lock with the user name and the optional pid. (No checking is done that the user or pid arguments are valid or meaningful; they are simply treated as strings.)

The EDIT command requires that the PR be locked before it may be successfully executed. However, it does not require that the lock is owned by the editing session, so the usefulness of the lock is simply as an advisory measure.

The APPN and REPL commands lock the PR as part of the editing process, and they do not require that the PR be locked before they are invoked.

PROTOCOL

LOCK <pr> <user> [pid]

RESPONSES

The possible responses are:

440 (CODE_CMD_ERROR)

Insufficient or too many arguments were specified to the command.

300 (CODE_PR_READY)

The lock was successfully obtained; the text of the PR (using the standard quoting mechanism for PRs) follows.

400 (CODE_NONEXISTENT_PR)

The PR specified does not exist.

430 (CODE_LOCKED_PR)

The PR is already locked by another session.

6xx (internal error)

The PR lock could not be created, usually because of permissions or other filesystem-related issues.