class Net::SFTP::Protocol::V06::Base

  1. lib/net/sftp/protocol/06/base.rb
Parent: V06

Wraps the low-level SFTP calls for version 6 of the SFTP protocol.

None of these protocol methods block--all of them return immediately, requiring the SSH event loop to be run while the server response is pending.

You will almost certainly never need to use this driver directly. Please see Net::SFTP::Session for the recommended interface.

Methods

Public Instance

  1. block
  2. link
  3. symlink
  4. unblock
  5. version

Protected Instance

  1. attribute_factory

Public Instance methods

block (handle, offset, length, mask)

Sends a FXP_BLOCK packet to the server to request that a byte-range lock be obtained on the given handle, for the given byte offset and length. The mask parameter is a bitfield indicating what kind of lock to acquire, and must be a combination of one or more of the Net::SFTP::Constants::LockTypes constants.

[show source]
# File lib/net/sftp/protocol/06/base.rb, line 41
def block(handle, offset, length, mask)
  send_request(FXP_BLOCK, :string, handle, :int64, offset, :int64, length, :long, mask)
end
unblock (handle, offset, length)

Sends a FXP_UNBLOCK packet to the server to request that a previously acquired byte-range lock be released on the given handle, for the given byte offset and length. The handle, offset, and length must all exactly match the parameters that were given when the lock was originally acquired (see block).

[show source]
# File lib/net/sftp/protocol/06/base.rb, line 50
def unblock(handle, offset, length)
  send_request(FXP_UNBLOCK, :string, handle, :int64, offset, :int64, length)
end
version ()

Returns the protocol version implemented by this driver. (6, in this case)

[show source]
# File lib/net/sftp/protocol/06/base.rb, line 18
def version
  6
end

Protected Instance methods

attribute_factory ()

Returns the Attributes class used by this version of the protocol (Net::SFTP::Protocol::V06::Attributes, in this case)

[show source]
# File lib/net/sftp/protocol/06/base.rb, line 58
def attribute_factory
  V06::Attributes
end