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

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

Разработчик

Ссылка платформы основы ссылка класса NSInputStream

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

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

NSInputStream

NSInputStream подкласс NSStream это обеспечивает потоковую функциональность только для чтения.

NSInputStream “бесплатный соединенный мостом” с его Базовым дубликатом Основы, CFReadStreamRef. Для получения дополнительной информации о бесплатном образовании моста посмотрите Бесплатное Образование моста.

Разделение на подклассы примечаний

NSInputStream конкретный подкласс NSStream это дает Вам стандартный доступ только для чтения к потоковым данным. Несмотря на то, что NSInputStream вероятно, достаточно для большинства ситуаций, требующих доступа к потоковым данным, можно создать подкласс NSInputStream если Вы хотите более специализированное поведение (например, Вы хотите записать статистику по данным в потоке).

Методы для переопределения

Создать подкласс NSInputStream Вам, вероятно, придется реализовать инициализаторы для типа потоковых поддерживаемых данных и соответственно повторно реализовать существующие инициализаторы. Необходимо также обеспечить полноценные внедрения следующих методов:

  • read:maxLength:

    От текущего индекса чтения возьмите до числа байтов, указанных во втором параметре от потока, и разместите их в предоставленный клиентами буфер (первый параметр). Буфер должен иметь размер, указанный вторым параметром. Возвратите фактическое число байтов, помещенных в буфер; если нет ничего в потоке, возвратиться 0. Сбросьте индекс в поток для следующей операции чтения.

  • getBuffer:length:

    Возвратитесь в 0 (1) указатель на выделенный подклассу буфер (первый параметр). Возврат ссылкой во втором параметре число байтов фактически помещается в буфер. Содержание буфера допустимо только до следующей операции с потоками. Возвратиться NOfalse если Вы не можете получить доступ к данным в буфере; иначе, возвратиться YEStrue. Если этот метод не является подходящим для Вашего типа потока, можно возвратиться NOfalse.

  • hasBytesAvailable

    Возвратиться YEStrue если существует больше данных для чтения в потоке, NOfalse если нет. Если Вы хотите быть семантически совместимыми с NSInputStream, возвратиться YEStrue если чтение должно быть опробовано, чтобы определить, доступны ли байты.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

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

Создание потоков
  • inputStreamWithData: + inputStreamWithData:

    Создает и возвращает инициализированный NSInputStream объект для чтения от данного NSData объект.

    Объявление

    Objective C

    + (instancetype)inputStreamWithData:(NSData *)data

    Параметры

    data

    Объект данных, из которого можно читать. Содержание data копируются.

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

    Инициализированный NSInputStream объект для чтения от data. Если data не объект NSData, этот метод возвраты nil.

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

    Objective C

    @import Foundation;

    Доступность

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

    См. также

    + inputStreamWithFileAtPath:
    – initWithData:

  • inputStreamWithFileAtPath: + inputStreamWithFileAtPath:

    Создает и возвращает инициализированный NSInputStream объект, считывающий данные из файла в данном пути.

    Объявление

    Objective C

    + (instancetype)inputStreamWithFileAtPath:(NSString *)path

    Параметры

    path

    Путь к файлу.

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

    Инициализированный NSInputStream объект, считывающий данные из файла в path.

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

    Objective C

    @import Foundation;

    Доступность

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

    См. также

    + inputStreamWithData:
    – initWithFileAtPath:
    – initWithURL:

  • inputStreamWithURL: + inputStreamWithURL:

    Создает и возвращает инициализированный NSInputStream объект, считывающий данные из файла в данном URL.

    Объявление

    Objective C

    + (instancetype)inputStreamWithURL:(NSURL *)url

    Параметры

    url

    URL к файлу.

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

    Инициализированный NSInputStream объект, считывающий данные из URL в url.

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

    Objective C

    @import Foundation;

    Доступность

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

    См. также

    + inputStreamWithData:

  • init (данные:) - initWithData: Определяемый инициализатор

    Инициализирует и возвращается NSInputStream объект для чтения от данного NSData объект.

    Объявление

    Swift

    init(data data: NSData)

    Objective C

    - (instancetype)initWithData:(NSData *)data

    Параметры

    data

    Объект данных, из которого можно читать. Содержание data копируются.

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

    Инициализированный NSInputStream объект для чтения от data.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – initWithFileAtPath:
    + inputStreamWithData:

  • init (fileAtPath:) - initWithFileAtPath:

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

    Объявление

    Swift

    convenience init?(fileAtPath path: String)

    Objective C

    - (instancetype)initWithFileAtPath:(NSString *)path

    Параметры

    path

    Путь к файлу.

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

    Инициализированный NSInputStream объект, считывающий данные из файла в path.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – initWithData:
    + inputStreamWithFileAtPath:
    + inputStreamWithURL:

  • init (URL:) - initWithURL: Определяемый инициализатор

    Инициализирует и возвращается NSInputStream объект, считывающий данные из файла в данном URL.

    Объявление

    Swift

    init?(URL url: NSURL)

    Objective C

    - (instancetype)initWithURL:(NSURL *)url

    Параметры

    url

    URL к файлу.

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

    Инициализированный NSInputStream объект, считывающий данные из файла в url.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – initWithData:

Используя потоки
  • читайте (_: maxLength:) - read:maxLength:

    Чтения до данного числа байтов в данный буфер.

    Объявление

    Swift

    func read(_ buffer: UnsafeMutablePointer<UInt8>, maxLength len: Int) -> Int

    Objective C

    - (NSInteger)read:(uint8_t *)buffer maxLength:(NSUInteger)len

    Параметры

    buffer

    Буфер данных. Буфер должен быть достаточно большим для содержания числа байтов, указанных len.

    len

    Максимальное количество байтов для чтения.

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

    Число, указывающее результат работы:

    • Положительное число указывает число чтения байтов;

    • 0 указывает, что был достигнут конец буфера;

    • Отрицательное число означает, что работа перестала работать.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • getBuffer (_: длина:) - getBuffer:length:

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

    Объявление

    Swift

    func getBuffer(_ buffer: UnsafeMutablePointer<UnsafeMutablePointer<UInt8>>, length len: UnsafeMutablePointer<Int>) -> Bool

    Objective C

    - (BOOL)getBuffer:(uint8_t **)buffer length:(NSUInteger *)len

    Параметры

    buffer

    По возврату, содержит указатель на буфер чтения. Буфер только допустим, пока не выполняется следующая операция с потоками.

    len

    По возврату, содержит число доступных байтов.

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

    YEStrue если буфер доступен, иначе NOfalse.

    Подклассы NSInputStream может возвратиться NOfalse если эта работа не является подходящей для потокового типа.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • hasBytesAvailable hasBytesAvailable Свойство

    Булево значение, указывающее, имеет ли получатель байты в наличии для чтения. (только для чтения)

    Объявление

    Swift

    var hasBytesAvailable: Bool { get }

    Objective C

    @property(readonly) BOOL hasBytesAvailable

    Обсуждение

    YEStrue если получатель имеет байты в наличии для чтения, иначе NOfalse. Май также возвращается YEStrue если чтение должно быть опробовано для определения доступности байтов.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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