MPNDeviceDelegate

public protocol MPNDeviceDelegate

Protocol to be implemented to receive MPNDevice events including registration, suspension/resume and status change.

Events for these delegates are dispatched by a different thread than the one that generates them. This means that, upon reception of an event, it is possible that the internal state of the client has changed. On the other hand, all the notifications for a single LightstreamerClient, including notifications to ClientDelegate, SubscriptionDelegate, ClientMessageDelegate, MPNDeviceDelegate and MPNSubscriptionDelegate will be dispatched by the same thread.

  • Event handler called when the MPNDeviceDelegate instance is added to an MPNDevice through MPNDevice.addDelegate(_:).

    This is the first event to be fired on the delegate.

    Declaration

    Swift

    func mpnDeviceDidAddDelegate(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice this instance was added to.

  • Event handler called when the MPNDeviceDelegate instance is removed from an MPNDevice through MPNDevice.removeDelegate(_:).

    This is the last event to be fired on the delegate.

    Declaration

    Swift

    func mpnDeviceDidRemoveDelegate(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice this instance was removed from.

  • Event handler called when an MPNDevice has been successfully registered on the server’s MPN Module.

    This event handler is always called before other events related to the same device.

    Note that this event can be called multiple times in the life of an MPNDevice instance in case the client disconnects and reconnects. In this case the device is registered again automatically.

    Declaration

    Swift

    func mpnDeviceDidRegister(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice instance involved.

  • Event handler called when an MPNDevice has been suspended on the server’s MPN Module.

    An MPN device may be suspended if errors occur during push notification delivery.

    Note that in some server clustering configurations this event may not be called.

    Declaration

    Swift

    func mpnDeviceDidSuspend(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice instance involved.

  • Event handler called when an MPNDevice has been resumed on the server’s MPN Module.

    An MPN device may be resumed from suspended state at the first subsequent registration.

    Note that in some server clustering configurations this event may not be called.

    Declaration

    Swift

    func mpnDeviceDidResume(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice instance involved.

  • Event handler called when the server notifies an error while registering an MPNDevice.

    By implementing this method it is possible to perform recovery actions.

    The error code can be one of the following:

    • 40 - the MPN Module is disabled, either by configuration or by license restrictions.

    • 41 - the request failed because of some internal resource error (e.g. database connection, timeout etc.).

    • 43 - invalid or unknown application ID.

    • 45 - invalid or unknown MPN device ID.

    • 48 - MPN device suspended.

    • 66 - an unexpected exception was thrown by the Metadata Adapter while authorizing the connection.

    • 68 - the Server could not fulfill the request because of an internal error.

    • <= 0 - the Metadata Adapter has refused the subscription request; the code value is dependent on the specific Metadata Adapter implementation.

    Declaration

    Swift

    func mpnDevice(_ device: MPNDevice, didFailRegistrationWithErrorCode code: Int, message: String?)

    Parameters

    device

    The MPNDevice instance involved.
    code

    The error code sent by the Server.
    message

    The description of the error sent by the Server; it can be nil.

  • Event handler called when the server notifies that an MPNDevice changed its status.

    Note that in some server clustering configurations the status change for the MPN device suspend event may not be called.

    See also

    MPNDevice.status

    See also

    MPNDevice.statusTimestamp

    Declaration

    Swift

    func mpnDevice(_ device: MPNDevice, didChangeStatus status: MPNDevice.Status, timestamp: Int64)

    Parameters

    device

    The MPNDevice instance involved.
    status

    The new status of the MPN device.
    timestamp

    The server-side timestamp of the new device status.

  • Event handler called when the server notifies that the list of MPN subscription associated with an MPNDevice has been updated.

    After registration, the list of pre-existing MPN subscriptions for an MPNDevice is updated and made available through the LightstreamerClient.MPNSubscriptions property.

    See also

    LightstreamerClient.MPNSubscriptions

    Declaration

    Swift

    func mpnDeviceDidUpdateSubscriptions(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice instance involved.

  • Event handler called when the server notifies that the badge of an MPNDevice has been reset.

    See also

    LightstreamerClient.resetMPNBadge()

    Declaration

    Swift

    func mpnDeviceDidResetBadge(_ device: MPNDevice)

    Parameters

    device

    The MPNDevice instance involved.

  • Event handler called when the server notifies an error while resetting the badge of an MPNDevice.

    By implementing this method it is possible to perform recovery actions.

    The error code can be one of the following:

    • 40 - the MPN Module is disabled, either by configuration or by license restrictions.

    • 41 - the request failed because of some internal resource error (e.g. database connection, timeout etc.).

    • 43 - invalid or unknown application ID.

    • 45 - invalid or unknown MPN device ID.

    • 48 - MPN device suspended.

    • 66 - an unexpected exception was thrown by the Metadata Adapter while authorizing the connection.

    • 68 - the Server could not fulfill the request because of an internal error.

    • <= 0 - the Metadata Adapter has refused the subscription request; the code value is dependent on the specific Metadata Adapter implementation.

    Declaration

    Swift

    func mpnDevice(_ device: MPNDevice, didFailBadgeResetWithErrorCode code: Int, message: String?)

    Parameters

    device

    The MPNDevice instance involved.
    code

    The error code sent by the Server.
    message

    The description of the error sent by the Server; it can be nil.