Class: Net::SFTP::Protocol::V06::Base

### Home Classes Methods

### In Files

- lib/net/sftp/protocol/06/base.rb

### Parent

Net::SFTP::Protocol::V05::Base

### Methods

- #attribute_factory
- #block
- #link
- #symlink
- #unblock
- #version

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- Net
- Net::SFTP
- Net::SFTP::Constants
- Net::SFTP::Constants::ACE
- Net::SFTP::Constants::ACE::Flag
- Net::SFTP::Constants::ACE::Mask
- Net::SFTP::Constants::ACE::Type
- Net::SFTP::Constants::LockTypes
- Net::SFTP::Constants::OpenFlags
- Net::SFTP::Constants::OpenFlags::FV1
- Net::SFTP::Constants::OpenFlags::FV5
- Net::SFTP::Constants::OpenFlags::FV6
- Net::SFTP::Constants::PacketTypes
- Net::SFTP::Constants::RenameFlags
- Net::SFTP::Constants::StatusCodes
- Net::SFTP::Exception
- Net::SFTP::Operations
- Net::SFTP::Operations::Dir
- Net::SFTP::Operations::Download
- Net::SFTP::Operations::File
- Net::SFTP::Operations::FileFactory
- Net::SFTP::Operations::Upload
- Net::SFTP::Packet
- Net::SFTP::Protocol
- Net::SFTP::Protocol::Base
- Net::SFTP::Protocol::V01
- Net::SFTP::Protocol::V01::Attributes
- Net::SFTP::Protocol::V01::Base
- Net::SFTP::Protocol::V01::Name
- Net::SFTP::Protocol::V02
- Net::SFTP::Protocol::V02::Base
- Net::SFTP::Protocol::V03
- Net::SFTP::Protocol::V03::Base
- Net::SFTP::Protocol::V04
- Net::SFTP::Protocol::V04::Attributes
- Net::SFTP::Protocol::V04::Base
- Net::SFTP::Protocol::V04::Name
- Net::SFTP::Protocol::V05
- Net::SFTP::Protocol::V05::Base
- Net::SFTP::Protocol::V06
- Net::SFTP::Protocol::V06::Attributes
- Net::SFTP::Protocol::V06::Base
- Net::SFTP::Request
- Net::SFTP::Response
- Net::SFTP::Session
- Net::SFTP::StatusException
- Net::SFTP::Version
- Net::SSH
- Net::SSH::Connection
- Net::SSH::Connection::Session

No matching classes.

# Net::SFTP::Protocol::V06::Base

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.

### Public Instance Methods

block(handle, offset, length, mask) click to toggle source

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.

    # 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

link(new_link_path, existing_path, symlink) click to toggle source

Sends a FXP_LINK packet to the server to request that a link be created at `new_link_path`, pointing to `existing_path`. If `symlink` is true, a symbolic link will be created; otherwise a hard link will be created.

    # File lib/net/sftp/protocol/06/base.rb, line 25
    def link(new_link_path, existing_path, symlink)
      send_request(FXP_LINK, :string, new_link_path, :string, existing_path, :bool, symlink)
    end

symlink(path, target) click to toggle source

Provided for backwards compatibility; v6 of the SFTP protocol removes the older FXP_SYMLINK packet type, so this method simply calls the link method.

    # File lib/net/sftp/protocol/06/base.rb, line 32
    def symlink(path, target)
      link(path, target, true)
    end

unblock(handle, offset, length) click to toggle source

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).

    # 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() click to toggle source

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

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

### Protected Instance Methods

attribute_factory() click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.