GRPC Objective-C  1.73.0
Data Structures | Functions
GRXWriter.h File Reference
#import <Foundation/Foundation.h>
#import "GRXWriteable.h"

Go to the source code of this file.

Data Structures

class  GRXWriter
 An GRXWriter object can produce, on demand, a sequence of values. More...
 

Functions

typedef NS_ENUM (NSInteger, GRXWriterState)
 States of a writer. More...
 

Function Documentation

◆ NS_ENUM()

typedef NS_ENUM ( NSInteger  ,
GRXWriterState   
)

States of a writer.

The writer has not yet been given a writeable to which it can push its values. To have a writer transition to the Started state, send it a startWithWriteable: message.

A writer's state cannot be manually set to this value.

The writer might push values to the writeable at any moment.

The writer is temporarily paused, and won't send any more values to the writeable unless its state is set back to Started. The writer might still transition to the Finished state at any moment, and is allowed to send writesFinishedWithError: to its writeable.

The writer has released its writeable and won't interact with it anymore.

One seldom wants to set a writer's state to this value, as its writeable isn't notified with a writesFinishedWithError: message. Instead, sending finishWithError: to the writer will make it notify the writeable and then transition to this state.