Перейти к основному содержимому

СоединениеFtp

Стд::Ftp::СоединениеFtp

Интерфейс для взаимодействия по протоколу FTP.

Сравнение

Ссылочное

Иерархия типа

Базовые типы: Закрываемое, Объект


Конструкторы

СоединениеFtp

СоединениеFtp(
Сервер: Строка,
Пользователь: Строка,
Пароль: Секрет|Строка,
Порт: Число = 21,
Кодировка: Кодировка|Строка = Кодировка.Utf8,
ТаймаутСоединения: Длительность = 15с,
ПассивныйРежим: Булево = Истина,
ДиапазонПортовАктивногоРежима: ЗакрытыйДиапазон<Число>? = Неопределено,
Прокси: ИнтернетПрокси? = Неопределено,
ИспользоватьSsl: Булево = Ложь,
ПараметрыЗащиты: ПараметрыЗащищенногоСоединения)
Открывает соединение с сервером Сервер по протоколу FTP.

Сервер - доменное имя или IP адрес удаленного сервера.

Uset - имя пользователя для подключения к серверу.

Пароль - пароль пользователя для подключения к серверу.

Порт - порт удаленного сервера.

Кодировка - кодировка команд.

ТаймаутСоединения - таймаут соединения с сервером.

ПассивныйРежим - использовать пассивный режим для передачи данных.

ДиапазонПортовАктивногоРежима - диапазон портов на стороне клиента, которые могут использоваться для передачи данных в активном режиме, включительно.

Прокси - параметры используемого прокси-сервера.

ИспользоватьSsl - использовать ли SSL/TLS при работе с сервером.

ПараметрыЗащиты - параметры защищенного соединения. По-умолчанию используются сертификаты системы.

Исключения

ИсключениеFtp - при ошибке подключения. ИсключениеНедопустимыйАргумент - если указано значение порта, которое за пределами диапазона допустимых значений (0-65535) или неподдерживаемая кодировка.


Свойства

ДиапазонПортовАктивногоРежима

ТолькоЧтение

ДиапазонПортовАктивногоРежима: ЗакрытыйДиапазон<Число>

Диапазон портов на стороне клиента, которые могут использоваться для передачи данных в активном режиме, включительно.


ПассивныйРежим

ТолькоЧтение

ПассивныйРежим: Булево

Использовать пассивный режим для передачи данных.


Пользователь

ТолькоЧтение

Пользователь: Строка

Имя пользователя.


Порт

ТолькоЧтение

Порт: Число

Порт сервера, к которому осуществляется подключение для передачи команд.


Прокси

ТолькоЧтение

Параметры используемого прокси-сервера.


Сервер

ТолькоЧтение

Сервер: Строка

Имя или адрес сервера, к которому осуществляется подключение.


Методы

Закрыть

Закрыть()
Закрывает текущее соединение. После вызова этого метода соединение больше нельзя использовать.

Исключения

ИсключениеFtp - в случае если соединение было закрыто ранее.

Переопределение
Закрываемое::Закрыть


Переместить

Переместить(
СтарыйПуть: Строка,
НовыйПуть: Строка,
Таймаут: Длительность? = Неопределено)
Перемещает файл со старого местоположения в новое.

СтарыйПуть - путь до исходного файла на удалённом сервере.

НовыйПуть - новое местоположение на удалённом сервере, куда должен быть перемещен исходный файл.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - в случае если файла не существует на сервере, по истечению таймаута или если соединение было закрыто.


Получить

Получить(
Путь: Строка,
Файл: Файл|Строка,
Таймаут: Длительность? = Неопределено)
Выполняет скачивание файла с удаленного сервера с записью на локальный диск.

Путь - путь до исходного файла на удалённом сервере FTP.

Файл - путь на локальном диске, куда будет скачан файл.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.

Перегрузка
Получить(Путь: Строка, Поток: ПотокЗаписи, Таймаут: Длительность? = Неопределено)


Получить

Получить(
Путь: Строка,
Поток: ПотокЗаписи,
Таймаут: Длительность? = Неопределено)
Выполняет скачивание файла с удаленного сервера с записью в указанный поток.

Путь - путь до исходного файла на удалённом сервере FTP.

Stream - объект потока записи, в который будет записано содержимое удаленного файла.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Перегрузка
Получить(Путь: Строка, Файл: Файл|Строка, Таймаут: Длительность? = Неопределено)


ПолучитьСписокФайлов

ПолучитьСписокФайлов(Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлFtp>
Получает список файлов и директорий в текущем рабочем каталоге сервера.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.

Перегрузка
ПолучитьСписокФайлов(Путь: Строка, Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлFtp>


ПолучитьСписокФайлов

ПолучитьСписокФайлов(
Путь: Строка,
Таймаут: Длительность? = Неопределено
): ЧитаемыйМассив<ФайлFtp>
Получает список файлов и директорий по пути Путь.

Путь - абсолютный путь директории на сервере.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.

Перегрузка
ПолучитьСписокФайлов(Таймаут: Длительность? = Неопределено): ЧитаемыйМассив<ФайлFtp>


ПолучитьТекущийКаталог

ПолучитьТекущийКаталог(Таймаут: Длительность? = Неопределено): Строка
Получает путь текущего рабочего каталога на сервере.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.


Поместить

Поместить(
Файл: Файл|Строка,
Путь: Строка?,
Таймаут: Длительность? = Неопределено)
Загружает локальный файл на удаленный сервер по указанному пути.

Файл - путь до локального файла или объект файла локальной файловой системы, который будет прочитан.

Путь - путь до итогового файла на удалённом сервере FTP. Если файл по указанному пути существует, то FTP сервер этот файл перезапишет.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - если файла не существует в локальной файловой системе,

Перегрузка
Поместить(ПотокЧтения: ПотокЧтения, Путь: Строка, Таймаут: Длительность? = Неопределено)


Поместить

Поместить(
ПотокЧтения: ПотокЧтения,
Путь: Строка,
Таймаут: Длительность? = Неопределено)
Загружает поток данных на удаленный сервер по указанному пути.

Stream - объект потока чтения, который предоставляет содержимое файла для передачи на удалённый сервер.

Путь - путь до итогового файла на удалённом сервере FTP. Если файл по указанному пути существует, то FTP сервер этот файл перезапишет.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.

Перегрузка
Поместить(Файл: Файл|Строка, Путь: Строка?, Таймаут: Длительность? = Неопределено)


СоздатьКаталог

СоздатьКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)
Создает каталог на удалённом сервере.

Путь - путь до нового каталога на удалённом сервере.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - по истечению таймаута или если соединение было закрыто.


Удалить

Удалить(
Путь: Строка,
Таймаут: Длительность? = Неопределено)
Удаляет файл по указанному пути с удаленного сервера.

Путь - путь до файла на FTP сервере, который должен быть удалён.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - в случае если файла не существует на сервере, по истечению таймаута или если соединение было закрыто.


УдалитьКаталог

УдалитьКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)
Удаляет файл по указанному пути с удаленного сервера.

Путь - путь до файла на FTP сервере, который должен быть удалён.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - в случае если файла не существует на сервере, по истечению таймаута или если соединение было закрыто.


УстановитьТекущийКаталог

УстановитьТекущийКаталог(
Путь: Строка,
Таймаут: Длительность? = Неопределено)
Устанавливает путь рабочего каталога на сервере.

Путь - путь до текущего рабочего каталога на удаленном сервере.

Таймаут - время ожидания завершения операции, при значении Неопределено время ожидания не ограничено.

Исключения

ИсключениеFtp - в случае если директории не существует, по истечению таймаута или если соединение было закрыто.


Список унаследованных методов

Закрываемое

Закрыть (Переопределение)

Объект

ВСтроку

ПолучитьТип

Представление