ОРИГИНАЛ ПЕРЕВОД Titanium.Network Titanium.Network submodule of Titanium submodule of Titanium 0.1 0.1 The top level Network module. The Network module is used accessing Networking related functionality. Модуль Network высшего уровня. Модуль Network используется для доступа к сетевым возможностям. Objects Объекты Description Название Описание The BonjourBrowser instance returned Экземпляр BonjourBrowser from возвращается из Titanium.Network.createBonjourBrowser. Titanium.Network.createBonjourBrowser. Titanium.Network.BonjourBrowser Titanium.Network.BonjourBrowser This object is a browser for the discovery Этот объект является браузером для and retrieval of Bonjour services available поиска и обнаружения доступного в on the network. сети сервиса Bonjour. The BonjourService instance returned Экземпляр BonjourService возвращается either from либо из Titanium.Network.createBonjourService Titanium.Network.createBonjourService, Titanium.Network.BonjourService or via the service list from a Titanium.Network.BonjourService либо через список сервисов из события BonjourBrowser updatedServices event. BonjourBrowser updatedServices. Этот This object describes a service on the объект описывает сервис в сети, network which is published by Bonjour. опубликованный Bonjour. The HttpClient instance returned from Экземпляр HttpClient возвращается из Titanium.Network.createHTTPClient. This Titanium.Network.createHTTPClient. Titanium.Network.HTTPClient object (mostly) implements the Titanium.Network.HTTPClient Этот объект (по большей части) XMLHttpRequest specification. реализует спецификацию XMLHttpRequest. The TCPSocket instance returned from Titanium.Network.createTCPSocket. This Экземпляр TCPSocket возвращается из object represents a socket which either Titanium.Network.createTCPSocket. Этот Titanium.Network.TCPSocket listens locally on the device for Titanium.Network.TCPSocket объект представляет собой сокет, connections, or connects to a remote который либо ожидает соединения на machine. устройстве, либо соединяет его с Name удаленной машиной Methods Методы Name Description adds a connectivity listener to listen for addConnectivityListen network changes. This method has been deprecated in favor of listening for a er change event. addEventListener add an event listener for the instance to receive view triggered events createBonjourBrowser create and return an instance of Titanium.Network.BonjourBrowser createBonjourService create and return an instance of Titanium.Network.BonjourService createHTTPClient create and return an instance of Titanium.Network.HTTPClient createTCPSocket create and return an instance of Titanium.Network.TCPSocket decodeURIComponent decode a URI component part using URI encoding encodeURIComponent encode a URI component part using URI encoding fireEvent fire a synthesized event to the views listener register for push notifications with the registerForPushNotific Apple Push Notification Service. Only ations available on iPhone. removes a connectivity listener. This removeConnectivityLi method has been deprecated in favor of stener listening for a change event. removeEventListener remove a previously added event listener Название Описание добавляет обработчик соединений для прослушивания сетевых изменений. От этого addConnectivityListener метода отказались в пользу прослушивания события change. добавляет к экземпляру обработчик событий addEventListener для получения инициируемых видом событий создает и возвращает экземпляр createBonjourBrowser Titanium.Network.BonjourBrowser создает и возвращает экземпляр createBonjourService Titanium.Network.BonjourService создает и возвращает экземпляр createHTTPClient Titanium.Network.HTTPClient создает и возвращает экземпляр createTCPSocket Titanium.Network.TCPSocket декодирует составную часть URI с помощью decodeURIComponent кодирования URI кодирует составную часть URI с помощью encodeURIComponent кодирования URI инициирует синтезированное событие в fireEvent перехватчике событий вида регистрирует push-уведомления с помощью registerForPushNotifications сервиса push-уведомлений Apple. Доступно только на iPhone. удаляет обработчика соединений. От этого removeConnectivityListener метода отказались в пользу прослушивания события change. удаляет ранее добавленный обработчик removeEventListener событий Свойства Название Тип Properties Name Description constant value representing the ability for INADDR_ANY string sockets to listen on any locally available network device constant value to indicate NETWORK_LAN int that the network is LAN constant value to indicate NETWORK_MOBILE int that the network is MOBILE constant value to indicate NETWORK_NONE int that the network is not available constant value to indicate NETWORK_UNKNOW int that the network is not N known constant value to indicate NETWORK_WIFI int that the network is WIFI NOTIFICATION_TYPE_ constant value for the push int ALERT notification alert type NOTIFICATION_TYPE_ constant value for the push int BADGE notification badge type NOTIFICATION_TYPE_ constant value for the push int SOUND notification sound type constant value specifying READ_MODE int read-only mode for sockets constant value specifying READ_WRITE_MODE int read-write mode for sockets WRITE_MODE Type int constant value specifying INADDR_ANY string NETWORK_LAN int NETWORK_MOBILE int NETWORK_NONE int NETWORK_UNKNOWN int NETWORK_WIFI int NOTIFICATION_TYPE_ALERT int NOTIFICATION_TYPE_BADGE int NOTIFICATION_TYPE_SOUND int READ_MODE int READ_WRITE_MODE int WRITE_MODE int networkType int Описание постоянное значение, представляющее собой возможность для сокета прослушивать любое доступное локально сетевое устройство постоянное значение для обозначения LAN сети постоянное значение для обозначения мобильной сети постоянное значение, указывающее, что сеть недоступна постоянное значение для обозначения неизвестной сети постоянное значение для WIFI сети постоянное значение для pushуведомлений типа «напоминание» постоянное значение для pushуведомлений типа «наклейка» постоянное значение для pushуведомлений звукового типа постоянное значение, задающее для сокетов режим только чтения. постоянное значение, задающее для сокетов режим чтениязаписи постоянное значение, задающее для сокетов режим только записи значение типа сети как константа. networkType int networkTypeName string online boole an remoteDeviceUUID string remoteNotificationTypes array remoteNotificationsEnabl boole ed an write-only mode for sockets the network type value as a constant. the network type name constant. Returns one of NONE, WIFI, LAN or MOBILE. readonly boolean value that indicates if the network is reachable to the Internet either via WIFI or Carrier network the remote device UUID if the device was registered with the Apple Push Notification Service or null if not set. Only available on iPhone. returns an array of network type constants enabled for the application. Only available on iPhone. returns true if remote notifications have been enabled. Only available on iPhone. networkTypeName online remoteDeviceUUID remoteNotificationTypes remoteNotificationsEnabled константа имени типа сети. Возвращает NONE, WIFI, LAN или MOBILE. булево значение только для чтения, указывающее доступен boolean ли выход в Интернет по WIFI или сети оператора универсальный уникальный идентификатор (UUID) удаленного устройства, если устройство было string зарегистрировано сервисом push-уведомлений Apple или пустой символ, если не было установлено. Доступно только на iPhone. возвращает массив констант типа сети, разрешенных для array приложения Доступно только на iPhone. возвращает истину, если удаленные уведомления были boolean разрешены Доступно только на iPhone. string События Название Описание срабатывает в ответ на изменение сетевого соединения Events Свойства события Name Description fired upon a network connectivity changeEvent properties change networkType the new network type change networkType новый тип сети networkTypeName новый тип сети в виде строки булеан, указывающий, есть ли online подключение к сети networkTypeName the new network type as a string online boolean to indicate if the network is online source the source object that fired the event type the name of the event fired source type объект, инициировавший событие название сработавшего события Объекты Titanium.Network.BonjourBrowser Titanium.Network.BonjourBrowser object of Titanium.Network объект Titanium.Network 1.2.0 1.2.0 The BonjourBrowser instance returned from Titanium.Network.createBonjourBrowser. Экземпляр BonjourBrowser возвращается из Titanium.Network.createBonjourBrowser. Этот объект является браузером для поиска и обнаружения доступного в сети сервиса Bonjour. Methods Description Conduct a search for Bonjour services matching the type and search domain specified during creation stopSearch Halt an ongoing search Методы Name Название Описание Производит поиск сервисов Bonjour, соответствующих типу и search домену, указанному при создании stopSearch Останавливает текущий поиск Properties Properties Name Type Description domain string The domain the browser is searching in isSearching boolean Whether or not the browser is currently searching serviceType string The type of the service the browser searches for Название Тип Описание domain string Домен, в котором браузер производит поиск Производит ли браузер поиск в данный isSearching boolean момент serviceType string Тип сервиса, который ищет браузер Events Название Events -event Name source the source object that fired the event type the name of the event fired services объект, инициировавший событие название сработавшего события массив объектов BonjourService, соответствующих доступным на данный момент сервисам. Если вы кэшируете значение, включая использование его в качестве табличных данных, вам нужно знать, что оно может устареть в любой момент. Это происходит из-за асинхронности обнаружения сервисов Bonjour. Event properties An array of BonjourService objects corresponding to currently available services. If you cache this value, including using it as table data, be aware that it could become out of date at any time due to the asynchronous nature of Bonjour service discovery. Свойства события source type Description updatedServices -event Описание services Свойства события source type Event properties объект, инициировавший событие название сработавшего события Срабатывает при обновлении найденного списка сервисов source the source object that fired the event type the name of the event fired Fired when the discovered services list is updated updatedServices updatedServices source Event properties type source the source object that fired the event type the name of the event fired Notes Свойства события объект, инициировавший событие название сработавшего события Примечания Если ваше приложение само публикует сервисы Bonjour, браузер при необходимости будет его обнаруживать; будьте готовы произвести проверку, если не хотите, чтобы локальные сервисы попали в список доступных сервисов. Поиск сервисов Bonjour – асинхронная операция. Это означает, что нужно быть предельно осторожным при кэшировании значений из свойств сервисов, возвращаемых событием updatedServices. В частности, если вы поддерживаете локальную копию доступных сервисов If your application publishes Bonjour services itself, that service will be discovered by the browser if necessary; be prepared to perform a check if you do not want to list local services as available. Bonjour service browsing is an asynchronous operation, meaning that you should be extremely careful when caching values from the 'services' property returned by the updatedServices event. In particular, if you maintain a local copy of available services and a user tries to connect to one, you should be prepared to handle failures gracefully; the next updatedServices event should provide the new services list, but you should not rely on it being delivered before user input. When a window which uses Bonjour browsing is closed, if you do not want to continue searching, you must call the stop() method. и пользователь пытается подсоединиться, будьте готовы стойко переносить неудачи. Следующее событие updatedServices предоставит новый список сервисов, но не надейтесь получить их раньше ввода пользователем данных. При закрытии окна, которое пользуется поиском Bonjour, нужно вызвать метод остановки, если вы не будете продолжать поиск. Titanium.Network.BonjourService Titanium.Network.BonjourService object of Titanium.Network объект Titanium.Network 1.2.0 1.2.0 The BonjourService instance returned either from Titanium.Network.createBonjourService or via the service list from a BonjourBrowser updatedServices event. This object describes a service on the network which is published by Bonjour. Экземпляр BonjourService возвращается либо из Titanium.Network.createBonjourService либо через список сервисов из события BonjourBrowser updatedServices. Этот объект описывает сервис в сети, опубликованный Bonjour. Methods Методы Name Description Publish a Bonjour service to the network. Only works if isLocal is publish TRUE Resolve a Bonjour service from the network. Must be done before resolve attempting to access the service's socket information, if a remote service. You cannot resolve a locally published service. stop Halts publication of a service. Properties Назва ние Описание Публикует сервис Bonjour в сети. Работает, только если isLocal является ИСТИНОЙ Получает сервис Bonjour из сети. Должен осуществляться перед resolve попыткой доступа к информации сокета сервиса, если сервис удаленный. Нельзя получить сервис, опубликованный локально stop Останавливает публикацию сервиса publish Свойства Events Назва Тип Описание ние domain string Домен сервиса isLocal boolean является ли сервис локальным для устройства name string имя сервиса объект TCPSocket, используемый для присоединения socket object к сервису type string тип сервиса This object has no events События Notes Данный объект не имеет событий You can only publish Bonjour services attached to a socket which is currently listening; you cannot publish a service for a remotely connected socket. If you stop the Bonjour service and wish to close the socket it uses, it is strongly recommended that you stop the service first. When a window which publishes a Bonjour service is closed, you must stop the service if the associated socket is also to be closed, or if it is no longer necessary to publish. Unlike other network operations, Bonjour service resolution and publishing is synchronous, so be aware that your code may block while resolution is going on. In particular, you may wish to display UI elements indicating background activity before beginning resolution. Примечания Titanium.Network.HTTPClient Titanium.Network.HTTPClient object of Titanium.Network Объект Titanium.Network 0.1 0.1 The HttpClient instance returned from Titanium.Network.createHTTPClient. Экземпляр HttpClient возвращается из Titanium.Network.createHTTPClient. Name Type Description domain string the domain of the service isLocal boolean whether or not the service is local to the device name string the name of the service socket object the TCPSocket object that is used to connect to the service type string the type of the service Публиковать можно только Bonjour-сервисы, привязанные сокету, который в данный момент ожидает соединения; нельзя публиковать сервис для удаленно подсоединенного сокета. Если вы отключаете сервис Bonjour и хотите закрыть сокет, который он использует, настоятельно рекомендуется сначала отключить сервис. При закрытии окна, которое публикует сервис Bonjour, нужно отключить сервис, если нужно закрыть соответствующий сокет или если больше нет необходимости его публиковать. В отличие от других сетевых операций, разрешение и публикация сервиса Bonjour синхронны, нужно знать, что ваш код может блокироваться в процессе разрешения. В частности, может возникнуть необходимость показать элементы UI, отображающие фоновую деятельность до начала разрешения. This object (mostly) implements the XMLHttpRequest specification. Methods Name Этот объект (по большей части) реализует спецификацию XMLHttpRequest. Методы Description abort abort a pending request getResponseHeader return the response header. open open the request and ready the connection send send the request set the request header. Must be called after open but before setRequestHeader send. setTimeout set the request timeout Properties Type Description DONE int the DONE readyState constant the HEADERS_RECEIVED readyState HEADERS_RECEIVED int constant LOADING int the LOADING readyState constant OPENED int the OPENED readyState constant UNSENT int the UNSET readyState constant boolean to indicate that the response was connected boolean successful the connection type, normally either GET connectionType string or POST. location string the absolute URL of the request set this to a function before calling open to cause the function to be called at regular functio intervals as the request data is being ondatastream n received. the progress property of the event will contain a value from 0.0-1.0 with the progress. Название Описание abort прерывает отложенный запрос getResponseHeader возвращает заголовок ответа open открывает запрос и подготавливает соединение send отправляет запрос устанавливает заголовок запроса. Должен вызваться setRequestHeader после open, но до send. setTimeout устанавливает тайм-аут запроса Свойства Name Название Тип int Описание DONE константа DONE readyState константа HEADERS_RECEIVED HEADERS_RECEIVED int readyState LOADING int константа LOADING readyState OPENED int константа OPENED readyState UNSENT int константа UNSET readyState булеан для обозначения успешного connected boolean ответа connectionType string тип соединения, обычно либо GET, либо POST location ondatastream абсолютный URL запроса устанавливается для функции перед вызовом open, чтобы функция вызывалась с регулярными интервалами function по мере получения ответной информации. Свойство progress события будет содержать значение от string onerror set this to a function before calling open to functio cause the function to be called upon a n error response onload set this to a function before calling open to functio cause the function to be called upon a n successful response onreadystatechange set this to a function before calling open to functio cause the function to be called for each n readyState change onsendstream set this to a function before calling open to cause the function to be called at regular functio intervals as the request data is being n transmitted. the progress property of the event will contain a value from 0.0-1.0 with the progress. readyState responseData int object responseText string responseXML object status int timeout int the readyState value the response data as a Blob object. the response as text or null if an error was received or no data was returned the response object as an XML DOMDocument object. returns null if the content type returned by the server was not XML or the content could not be parsed the response HTTP status code timeout is milliseconds when the connection should be aborted set this to control how SSL certification validation is performed on connection. validatesSecureCertificat boolean defaults to false if in simulator or device e testing and true if release for distribution mode. Events 0.0-1.0 с шагом развитием. устанавливается до вызова open, чтобы onerror function функция вызывалась при ошибочном ответе устанавливается до вызова open, чтобы onload function функция вызывалась при успешном ответе установите его до вызова open, чтобы onreadystatechange function функция вызывалась при каждом изменении readyState устанавливается до вызова open, чтобы функция вызывалась при каждом изменении readyState с регулярными onsendstream function интервалами при передаче данных запроса. Свойство progress события будет содержать значение от 0.0-1.0 с шагом развития. readyState int значение readyState responseData object данные ответа в виде двоичного объекта ответ в виде текста или пустого responseText string значения, если была получена ошибка или данные были возвращены объект ответа в виде объекта XML DOMDocument. возвращает пустое значение, если тип содержания, responseXML object возвращаемый сервером, не является XML или содержание не могло быть проанализировано status int код состояния HTTP ответа тайм-аут в миллисекундах, в который timeout int соединение должно быть прервано устанавливается для контроля над выполнением проверки сертификата validatesSecureCertificate boolean SSL при соединении. По умолчанию ложь для симулятора или тестирования утсройства, истина при выпуске для режима дистрибуции This object has no events События Данный объект не имеет событий Titanium.Network.TCPSocket Titanium.Network.TCPSocket object of Titanium.Network Объект Titanium.Network 1.2.0 1.2.0 The TCPSocket instance returned from Titanium.Network.createTCPSocket. This object represents a socket which either listens locally on the device for connections, or connects to a remote machine. Экземпляр TCPSocket возвращается из Titanium.Network.createTCPSocket. Этот объект представляет собой сокет, который либо ожидает соединения на устройстве, либо соединяет его с удаленной машиной. Методы Methods Name Description close close the socket connect connect the scocket to a TCP server listen set up the socket to receive connections write data to the socket, if the mode is WRITE_MODE or write READ_WRITE_MODE Назва Описание ние close закрывает сокет connect соединяет сокет с TCP сервером listen устанавливает сокет для приема соединений write записывает данные в сокет в режимах записи или чтения и записи Свойства Properties Name Type Description the host name to connect to. Must be INADDR_ANY or an hostName string identifier for the local device in order to listen isValid boolean whether or not the socket is valid mode int the socket's mode port int the port to connect/listen on Названи е Тип имя компьютера, к которому совершается соединение. Для прослушивания должен быть INADDR_ANY или идентификатор для локального устройства boolean является ли сокет допустимым int режим сокета hostName string isValid mode Описание port int порт для соединения/прослушивания События Название Events Name Description new data was read off the socket Event properties read data[object] from[int] source type Свойства события read a blob representing the data read, can be interpreted via toString the reference for the socket that data was retrieved from the source object that fired the event the name of the event fired readError code[int] the BSD socket error code error[string] a description of the error source the source object that fired the event type the name of the event fired двоичный объект, представляющий собой data[object] прочитанные данные, может интерпретироваться с помощью toString ссылка на сокет, с которого были получены from[int] данные source объект, инициировавший событие type название сработавшего события произошла ошибка во время чтения Свойства события an error occured when reading Event properties Описание новые данные были считаны с сокета readError code[int] код ошибки BSD-сокета error[string] описание ошибки объект, инициировавший source событие type название сработавшего события произошла ошибка во время записи an error occured when writing Свойства события Event properties writeError code[int] the BSD socket error code error[string] a description of the error source the source object that fired the event type the name of the event fired код ошибки BSD-сокета writeError code[int] error[string] описание ошибки объект, инициировавший source событие type название сработавшего события Примечания Сокеты нетривиальны; каждому, кто их использует рекомендуется ознакомиться с основами работы с BSD-сокетами. Все сокеты используют TCP-соединения и являются асинхроными для операций чтения, поэтому Sockets are nontrivial; it is recommended that anyone using them be familiar ваша программа должна быть готова к получению события 'read' в любой with the basics of BSD sockets. All sockets use TCP connections, and are момент. Ссылки на сокет не могут передаваться объектам сокета, и asynchronous for read operations, so your program should be ready to receive наоборот – ссылки на сокет являются внутренним механизмом для 'read' events at any point. Socket references cannot be transferred to socket определния, какому сокету отправляются данные и с какого считываются. objects, and vice-versa - socket references are an internal mechanism which is Для слушающих сокетов настоятельно рекомендуется использовать used only to determine which sockets to send data to and read data from. For константу Titanium.Network.INADDR_ANY в качестве имени компьютера. listening sockets, it is highly recommended that you use the Если закрывается окно, содержащее сокет, сокет также ДОЛЖЕН быть Titanium.Network.INADDR_ANY constant as the host name. If a window containing a socket is closed, the socket MUST be closed also unless you intend закрыт, если только вы не собираетесь продолжать прием данных, иначе сокет будет потреблять ресурсы (и будет потенциально создавать to continue to receive data, otherwise the socket will consume resources (and potentially cause conflicts with opening the window again, if a listener) until the конфликты при очередном открытии окна, если он является слушающим) до перезапуска программы. Не забывайте о различиях между функциями program is restarted. Be aware of the differences between the listen() and listen() и connect(); попытка заменить одну другой может привести к connect() functions; attempting to use one when you mean the other may result ошибке, непредсказуемому поведению или тому и другому одновременно. in errors, unpredictable behavior, or both. Notes