CBLMessageEndpointListener

@interface CBLMessageEndpointListener : NSObject

The listener for incoming message endpoint connections.


                    
                    
                    connections

The active connections.

Declaration

Objective-C

@property (readonly, atomic)
    NSArray<id<CBLMessageEndpointConnection>> *_Nonnull connections;


                    
                    
                    -initWithConfig:

Initializes the CBLMessageEndpointListener object with the given configuration.

Declaration

Objective-C

- (nonnull instancetype)initWithConfig:
    (nonnull CBLMessageEndpointListenerConfiguration *)config;

Swift

init(config: CBLMessageEndpointListenerConfiguration)

Parameters


                                config

The configuration object.

Return Value

The CBLMessageEndpointListener object.


                    
                    
                    -accept:

Accepts the incoming message endpoint connection.

Declaration

Objective-C

- (void)accept:(nonnull id<CBLMessageEndpointConnection>)connection;

Parameters


                                connection

The CBLMessageEndpointConnection object.


                    
                    
                    -close:

Closes the given message endpoint connection.

Declaration

Objective-C

- (void)close:(nonnull id<CBLMessageEndpointConnection>)connection;

Parameters


                                connection

The CBLMessageEndpointConnection object

-closeAll
Closes all active connections.
Declaration
Objective-C

- (void)closeAll;
Swift

func closeAll()

Change Listeners


                    
                    
                    -addChangeListener:

Adds a change listener. Changes will be posted on the main queue.

Declaration

Objective-C

- (nonnull id<CBLListenerToken>)addChangeListener:
    (nonnull void (^)(CBLMessageEndpointListenerChange *_Nonnull))listener;

Parameters


                                listener

The listener to post the changes.

Return Value

An opaque listener token object for removing the listener.


                    
                    
                    -addChangeListenerWithQueue:listener:

Adds a change listener with the dispatch queue on which changes will be posted. If the dispatch queue is not specified, the changes will be posted on the main queue.

Declaration

Objective-C

- (nonnull id<CBLListenerToken>)
addChangeListenerWithQueue:(nullable dispatch_queue_t)queue
                  listener:
                      (nonnull void (^)(
                          CBLMessageEndpointListenerChange *_Nonnull))listener;

Parameters

`queue`	The dispatch queue.
`listener`	The listener to post changes.

Return Value

An opaque listener token object for removing the listener.


                    
                    
                    -removeChangeListenerWithToken:

Removes a change listener with the given listener token.

Declaration

Objective-C

- (void)removeChangeListenerWithToken:(nonnull id<CBLListenerToken>)token;

Parameters


                                token

The listener token.

-init
Not available
Declaration
Objective-C

- (nonnull instancetype)init;