Back to Rxswift

PublishSubject

docs/Classes/PublishSubject.html

6.10.22.1 KB
Original Source

PublishSubject

public final class PublishSubject<Element>:
    Observable<Element>,
    SubjectType,
    Cancelable,
    ObserverType,
    SynchronizedUnsubscribeType

Represents an object that is both an observable sequence as well as an observer.

Each notification is broadcasted to all subscribed observers.

`

                SubjectObserverType
                `

Undocumented

Declaration

Swift

public typealias SubjectObserverType = PublishSubject<Element>

`

                hasObservers
                `

Indicates whether the subject has any observers

Declaration

Swift

public var hasObservers: Bool { get }

`

                isDisposed
                `

Indicates whether the subject has been isDisposed.

Declaration

Swift

public var isDisposed: Bool { get }

`

                init()
                `

Creates a subject.

Declaration

Swift

override public init()

`

                on(_:)
                `

Notifies all subscribed observers about next event.

Declaration

Swift

public func on(_ event: Event<Element>)

Parameters

| event |

Event to send to the observers.

|

`

                subscribe(_:)
                `

Subscribes an observer to the subject.

Declaration

Swift

override public func subscribe<Observer>(_ observer: Observer) -> Disposable where Element == Observer.Element, Observer : ObserverType

Parameters

| observer |

Observer to subscribe to the subject.

|

Return Value

Disposable object that can be used to unsubscribe the observer from the subject.

`

                asObserver()
                `

Returns observer interface for subject.

Declaration

Swift

public func asObserver() -> PublishSubject<Element>

`

                dispose()
                `

Unsubscribe all observers and release resources.

Declaration

Swift

public func dispose()