Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка класса IOFireWireSBP2Login

Опции
Развертывание Target:

На этой странице
Язык:

IOFireWireSBP2Login

Предоставляет обслуживание входа в систему и Нормальную Команду части выполнения ORB API.

Предоставления APIs для выполнения обслуживания и команды входа в систему. Драйверы могут использовать этот объект создать объекты IOFireWireSBP2ORB и выполнить их. Требуемые и незапрашиваемые подпрограммы обратного вызова состояния могут быть зарегистрированы, и службы SBP2 уведомят драйвер, когда поступит надлежащее состояние. Этот класс также обрабатывает обслуживание входа в систему. Предоставления APIs для того, чтобы войти в систему и выйти из системы и попытки повторно соединиться с ЛУНОМ после сброса шины. Основные службы FireWire поставляют уведомление сброса шины через подпрограмму сообщения IOKit. Службы SBP2 основываются на этом поведении и поставляют reconnectFailed и reconnectComplete через подпрограмму сообщения также.

Наследование

Не применимый

Соответствует

Не применимый

Оператор импорта

Не применимый

Objective C

@import Kernel;

Доступность

Доступный в OS X v10.0 и позже.

Прочие условия
  • createORB - createORB

    Создает новый IOFireWireSBP2ORB для этого входа в систему.

    Объявление

    C++

    virtual IOFireWireSBP2ORB * createORB( void );

    Возвращаемое значение

    Возвращает указатель на новый объект ORB.

    Обсуждение

    Создайте новый IOFireWireSBP2ORB для этого входа в систему. Это может быть сконфигурировано с, он - средства доступа и выполняемый с submitORB ниже.

  • enableUnsolicitedStatus - enableUnsolicitedStatus

    Включает незапрашиваемое состояние.

    Объявление

    C++

    virtual IOReturn enableUnsolicitedStatus( void );

    Возвращаемое значение

    Возвраты kIOReturnSuccess, если состояние включает запись, запустились успешно.

    Обсуждение

    После незапрашиваемый отправляется, устройство не отправит дополнительного незапрашиваемого состояния, пока не будет записан определенный регистр. Это служит своего рода управлением потоком для незапрашиваемого состояния. После того, как незапрашиваемое состояние получено, и обработанные драйверы захотят повторно включить поставку unsolicted состояния вызовом к этому методу.

  • getLoginFlags - getLoginFlags

    Возвращается в настоящее время флаги входа в систему набора.

    Объявление

    C++

    virtual UInt32 getLoginFlags( void );

    Возвращаемое значение

    Возвращает UInt32, содержащий в настоящее время флаги входа в систему набора.

    Обсуждение

    Возвращает текущее состояние флагов входа в систему. В настоящее время существует только один флаг, определенный для этого API. kFWSBP2ExclusiveLogin указывает, что монопольный вход в систему укусил, должен быть установлен во входе в систему ORB.

  • getLoginID - getLoginID

    Возвращает текущий идентификатор для входа в систему.

    Объявление

    C++

    virtual UInt32 getLoginID( void );

    Возвращаемое значение

    Возвращает UInt32, содержащий текущий идентификатор для входа в систему.

    Обсуждение

    Когда мы успешно входим в систему к устройству. Устройство дает нам уникальный идентификатор для входа в систему. Это используется внутренне для пересоединения с устройством после сброса шины и наверняка другого управления ORBs. Большинство драйверов, вероятно, не заинтересовано этим значением.

  • getMaxCommandBlockSize - getMaxCommandBlockSize

    Возвращает максимальный размер блока команды.

    Объявление

    C++

    virtual UInt32 getMaxCommandBlockSize( void );

    Возвращаемое значение

    Возвращает UInt32, содержащий максимальный размер блока команды.

    Обсуждение

    Устройство публикует верхний предел размера блока команды, который это может принять. К тому значению можно получить доступ через этот метод.

  • getMaxPayloadSize - getMaxPayloadSize

    Возвращается в настоящее время размер полезной нагрузки максимума набора.

    Объявление

    C++

    virtual UInt32 getMaxPayloadSize( void );

    Возвращаемое значение

    Возвращает UInt32, содержащий в настоящее время размер полезной нагрузки максимума набора.

    Обсуждение

    Возвращает в настоящее время глобальный максимальный размер полезной нагрузки в байтах.

  • getReconnectTime - getReconnectTime

    Возвращается в настоящее время время переподключения набора.

    Объявление

    C++

    virtual UInt32 getReconnectTime( void );

    Возвращаемое значение

    Возвращает UInt32, содержащий в настоящее время время переподключения набора.

    Обсуждение

    Возвращает в настоящее время желаемое время переподключения инициатора, закодированное как 2^time секунды.

  • getRefCon - getRefCon

    Возвращает набор refCon с setRefCon.

    Объявление

    C++

    virtual void * getRefCon( void );

    Возвращаемое значение

    Возвращает ранее сохраненное определяемое пользователем значение.

    Обсуждение

    Возвращает определяемое пользователем значение, ранее сохраненное во входе в систему setRefCon.

  • getStatusNotifyProc - getStatusNotifyProc

    Возвращает обратный вызов, который вызовут на нормальном состоянии команды.

    Объявление

    C++

    virtual void getStatusNotifyProc( void **refCon, FWSBP2NotifyCallback *callback );

    Параметры

    refCon

    выходной параметр, возвращая refCon, который будет передан обратному вызову.

    callback

    выходной параметр, возвращая адрес обратного вызова.

    Обсуждение

    Возвращает refCon, и адрес обратного вызова состояния уведомляют обратный вызов.

  • getUnsolicitedStatusNotifyProc - getUnsolicitedStatusNotifyProc

    Возвращает обратный вызов, который вызовут на незапрашиваемом состоянии.

    Объявление

    C++

    virtual void getUnsolicitedStatusNotifyProc( void **refCon, FWSBP2NotifyCallback *callback );

    Параметры

    refCon

    выходной параметр, возвращая refCon, который будет передан обратному вызову.

    callback

    выходной параметр, возвращая адрес обратного вызова.

    Обсуждение

    Возвращает refCon, и адрес обратного вызова незапрашиваемого состояния уведомляют обратный вызов.

  • выпуск - выпуск

    Основная реализация механизма выпуска.

    Объявление

    C++

    virtual void release() const;

    Обсуждение

    См. OSObject.h для получения дополнительной информации. == когда retainCount, когда тогда вызывают свободный ().

  • ringDoorbell - ringDoorbell

    Звонит в дверь на ЛУНЕ.

    Объявление

    C++

    virtual IOReturn ringDoorbell( void );

    Возвращаемое значение

    Возвраты kIOReturnSuccess, если кольцо запустилось успешно.

    Обсуждение

    Ненепосредственный добавляет к цепочке ORB, может потребовать, чтобы конечный автомат агента выборки был уведомлен относительно нового присутствия ORB's. Это выполняется путем записи в так называемый регистр дверного звонка. Этот метод начинает одну из тех записей.

  • setBusyTimeoutRegisterValue - setBusyTimeoutRegisterValue

    Устанавливает значение, которое будет записано в регистр BUSY_TIMEOUT.

    Объявление

    C++

    virtual void setBusyTimeoutRegisterValue( UInt32timeout );

    Параметры

    timeout

    требуемое значение регистра BUSY_TIMEOUT.

    Обсуждение

    1394-1995 определяет регистр, известный как регистр BUSY_TIMEOUT. Этот регистр управляет занятым поведением повторной попытки Вашего устройства. Начальное значение для этого регистра является 0x00000000. Что означает, что не будут повторены занятые транзакции. Так как большинство устройств хочет свои транзакции, удаленные на занятом acks, служба SBP2 автоматически обновляет регистр BUSY_TIMEOUT со значением, указанным здесь каждый раз, когда необходимо. Большинство драйверов должно установить это значение в 0x0000000f.

  • setFetchAgentResetCompletion - setFetchAgentResetCompletion

    Устанавливает обратный вызов, который вызовут, когда завершается сброс агента выборки.

    Объявление

    C++

    virtual void setFetchAgentResetCompletion( void *refCon, FWSBP2StatusCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2FetchAgentWriteCallback.

    Обсуждение

    Конечный автомат агента выборки на устройстве может быть сброшен записью к определенному регистру. Службы SBP2 предлагают служебный метод сбросить агент выборки. Когда эта запись отдыха завершается, можно зарегистрировать подпрограмму обратного вызова здесь, чтобы быть уведомленными.

  • setFetchAgentWriteCompletion - setFetchAgentWriteCompletion

    Устанавливает обратный вызов, который вызовут, когда завершается запись агента выборки.

    Объявление

    C++

    virtual void setFetchAgentWriteCompletion( void *refCon, FWSBP2FetchAgentWriteCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2FetchAgentWriteCallback.

    Обсуждение

    То, когда непосредственный шар выполняется с submitORB, это - адрес, записано в определенный адрес на устройстве. Этот адрес вызывают агентом выборки. Устройство чтения, что шар от памяти Mac и выполняет его. Когда эта запись к агенту выборки завершается, с этим вызовом можно зарегистрироваться, чтобы быть призванными обратно. Службы SBP2 гарантируют, что запись агента выборки будет завершена, прежде чем о состоянии сообщат для ORB, таким образом, для большинства драйверов не требуется это уведомление.

  • setLoginCompletion - setLoginCompletion

    Устанавливает обратный вызов, который вызовут, когда попытка входа в систему завершена.

    Объявление

    C++

    virtual void setLoginCompletion( void *refCon, FWSBP2LoginCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2LoginCallback.

    Обсуждение

    Когда попытка входа в систему завершилась, предоставленный обратный вызов вызывают. «состояние» в параметрических усилителях обратного вызова должно быть проверено для определения успешности или неуспешности попытки входа в систему. Если «statusBlock» является ненулем, тогда входят в систему, состояние было записано, и это было предоставлено здесь. Если попытка входа в систему была успешна тогда, ответ входа в систему будет предоставлен в буфере «loginResponse».Примечание: все буферы, предоставленные обратным вызовам, только допустимы на время обратного вызова. Кроме того, Вы не должны изменять содержание никакого предоставленного буфера.

  • setLoginFlags - setLoginFlags

    Наборы входят в систему флаги конфигурации.

    Объявление

    C++

    virtual void setLoginFlags( UInt32loginFlags );

    Параметры

    loginFlags

    флаги конфигурации входа в систему.

    Обсуждение

    Конфигурирует поведение входа в систему согласно предоставленным флагам. В настоящее время два флага определяются для этого API. kFWSBP2ExclusiveLogin устанавливает монопольный бит входа в систему во входе в систему ORB. kFWSBP2DontSynchronizeMgmtAgent позволяет одновременное имя для входа в систему или переподключения к LUNs с общим агентом управления (т.е. LUNs в том же каталоге модуля).

  • setLoginRetryCountAndDelayTime - setLoginRetryCountAndDelayTime

    Наборы входят в систему поведение повторной попытки.

    Объявление

    C++

    virtual void setLoginRetryCountAndDelayTime( UInt32retryCount, UInt32uSecs );

    Параметры

    retryCount

    число раз для повторения имени для входа в систему

    uSecs

    время задержки в микросекундах между повторениями входа в систему

    Обсуждение

    Наборы входят в систему поведение повторной попытки.

  • setLogoutCompletion - setLogoutCompletion

    Устанавливает обратный вызов, который вызовут, когда попытка выхода из системы завершена.

    Объявление

    C++

    virtual void setLogoutCompletion( void *refCon, FWSBP2LogoutCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2LogoutCallback.

    Обсуждение

    Когда попытка выхода из системы завершилась, предоставленный обратный вызов вызывают. «состояние» в параметрических усилителях обратного вызова должно быть проверено для определения успешности или неуспешности попытки выхода из системы. Если «statusBlock» является ненулем, тогда выходят из системы, состояние было записано, и это было предоставлено здесь.Примечание: все буферы, предоставленные обратным вызовам, только допустимы на время обратного вызова. Кроме того, Вы не должны изменять содержание никакого предоставленного буфера.

  • setMaxPayloadSize - setMaxPayloadSize

    Устанавливает максимальную продолжительность передачи данных для нормальной команды ORB.

    Объявление

    C++

    virtual void setMaxPayloadSize( UInt32reconnectTime );

    Параметры

    reconnectTime

    Желаемый максимальный размер полезной нагрузки в байтах.

    Обсуждение

    Устанавливает максимальную продолжительность передачи данных для нормальной команды ORB. Это значение является максимумом для всего ORBs, отправленного в этот ЛУН. Это может быть обрезано далее на ORB основанием ORB подобным вызовом в самом IOFireWireSBP2ORB.

  • setPassword (IOMemoryDescriptor *) - setPassword (IOMemoryDescriptor *)

    Устанавливает пароль входа в систему.

    Объявление

    C++

    virtual IOReturn setPassword( IOMemoryDescriptor *memory );

    Параметры

    memory

    IOMemoryDescriptor, ссылающийся на пароль.

    Возвращаемое значение

    Возвраты kIOReturnSuccess на успехе.

    Обсуждение

    Устанавливает пароль входа в систему с помощью IOMemoryDescriptor. Альтернативная версия существует, который принимает буфер и длину. Если длина пароля равняется 8 или меньше, пароль копируется непосредственно в шар входа в систему. Если длина больше, чем 8, на буфер ссылается адрес во входе в систему ORB.

  • setPassword (недействительный *, UInt32) - setPassword (недействительный *, UInt32)

    Устанавливает пароль входа в систему.

    Объявление

    C++

    virtual IOReturn setPassword( void *buf, UInt32len );

    Параметры

    buf

    указатель на буфер пароля.

    len

    длина в байтах буфера пароля.

    Возвращаемое значение

    Возвраты kIOReturnSuccess на успехе.

    Обсуждение

    Устанавливает пароль входа в систему с помощью буфера и длины. Альтернативная версия существует, который принимает IOMemoryDescriptor. Если длина пароля равняется 8 или меньше, пароль копируется непосредственно в шар входа в систему. Если длина больше, чем 8, на буфер ссылается адрес во входе в систему ORB. В этом случае буфер не копируется и должен остаться выделенным на время попытки входа в систему.

  • setReconnectTime - setReconnectTime

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

    Объявление

    C++

    virtual void setReconnectTime( UInt32reconnectTime );

    Параметры

    reconnectTime

    Желаемый тайм-аут переподключения, закодированный как 2^reconnectTime секунды.

    Обсуждение

    Цель и инициатор решают продолжительность в арбитражном порядке тайм-аута переподключения. Здесь инициатор указывает его желаемое время тайм-аута в 2^reconnectTime секунды. После успешного входа в систему возвращается устройство, фактический тайм-аут оценивают его, хочет использовать. Это значение может быть меньше, чем тайм-аут переподключения, который указал intiator, является ли это всем, что может поддерживать устройство.

  • setRefCon - setRefCon

    Устанавливает вход в систему refCon.

    Объявление

    C++

    virtual void setRefCon( void *refCon );

    Параметры

    refCon

    определяемое пользователем значение.

    Обсуждение

    Устанавливает определяемое пользователем значение на входе в систему, который может быть получен позже с методом getRefCon.

  • setStatusNotifyProc - setStatusNotifyProc

    Устанавливает обратный вызов, который вызовут на нормальном состоянии команды.

    Объявление

    C++

    virtual void setStatusNotifyProc( void *refCon, FWSBP2NotifyCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2NotifyCallback.

    Обсуждение

    Предоставленный обратный вызов вызывают, когда нормальное состояние команды получено, когда нормальная команда испытывает таймаут, или когда прерывается нормальная команда. «notificationEvent» в параметрических усилителях обратного вызова укажет то, что произошло. Это будет установлено в одно из следующих значений: kFWSBP2NormalCommandReset, kFWSBP2NormalCommandStatus, или kFWSBP2NormalCommandTimeout. Если тип события является kFWSBP2NormalCommandTimeout, и «len» является ненулевым, тогда «обмениваются сообщениями», содержит данные, записанные в блок состояния.

  • setUnsolicitedStatusNotifyProc - setUnsolicitedStatusNotifyProc

    Устанавливает обратный вызов, который вызовут на нормальном состоянии команды.

    Объявление

    C++

    virtual void setUnsolicitedStatusNotifyProc( void *refCon, FWSBP2NotifyCallbackcallback );

    Параметры

    refCon

    refCon передал обратному вызову.

    callback

    адрес метода обратного вызова типа FWSBP2NotifyCallback.

    Обсуждение

    Когда незапрашиваемое состояние получено, предоставленный обратный вызов вызывают. «notificationEvent» в параметрических усилителях обратного вызова укажет то, что произошло. В этом случае это будет установлено в kFWSBP2UnsolicitedStatus. Если «len» является ненулевым, тогда «обмениваются сообщениями», содержит данные, записанные в блок состояния.Примечание: любые буферы, возвращенные обратными вызовами, только допустимы на время входа в систему и не должны изменять свое содержание.

  • submitFetchAgentReset - submitFetchAgentReset

    Сбрасывает агент выборки ЛУНА.

    Объявление

    C++

    virtual IOReturn submitFetchAgentReset( void );

    Возвращаемое значение

    Возвраты kIOReturnSuccess, если сброс запустился успешно.

    Обсуждение

    Конечный автомат агента выборки на устройстве может быть сброшен записью к определенному регистру. Этот сброс может быть intiated вызовом к этому методу. Уведомление о завершении этой записи может иметься путем регистрации обратного вызова с setFetchAgentResetCompletion методом.

  • submitLogin - submitLogin

    Попытки войти в систему в ЛУН.

    Объявление

    C++

    virtual IOReturn submitLogin( void );

    Возвращаемое значение

    Возвраты kIOReturnSuccess вход в систему имеют начатый successlly.

    Обсуждение

    Этот вызов начинает процесс входа в систему. Объект входа в систему должен быть сконфигурирован до этого вызова. Если kIOReturnSuccess будет возвращен из этого вызова тогда, то loginCompletion подпрограмму вызовут, когда вход в систему завершится (успешно или неуспешно).

  • submitLogout - submitLogout

    Попытки к выходу из системы ЛУНА.

    Объявление

    C++

    virtual IOReturn submitLogout( void );

    Возвращаемое значение

    Возвраты kIOReturnSuccess, если успешно начался выход из системы.

    Обсуждение

    Этот вызов начинает процесс выхода из системы. Если kIOReturnSuccess будет возвращен из этого вызова тогда, то logoutCompletion подпрограмму вызовут, когда выход из системы завершится (успешно или неуспешно).

  • submitORB - submitORB

    Представляет данный шар

    Объявление

    C++

    virtual IOReturn submitORB( IOFireWireSBP2ORB *orb );

    Параметры

    orb

    Шар, который будет выполняться.

    Возвращаемое значение

    Возвраты kIOReturnSuccess, если ORB был запущен успешно.

    Обсуждение

    Запускает выполнение данного ORB. Если ORB является непосредственный ORB, это - адрес, записан в агент выборки. Если это - не непосредственный шар, его адрес добавляется к последнему шару в настоящее время обрабатывающей цепочки. Дверному звонку не звонят автоматически, он должен быть выполнен вручную с ringDoorbell командой, описанной ниже.