com.pubnub.internal.BasePubNubImpl.kt Maven / Gradle / Ivy

Go to download
package com.pubnub.internal

import com.pubnub.api.BasePubNub
import com.pubnub.api.callbacks.Listener
import com.pubnub.api.models.consumer.access_manager.v3.PNToken
import com.pubnub.api.v2.BasePNConfiguration
import com.pubnub.api.v2.callbacks.BaseEventEmitter
import com.pubnub.api.v2.callbacks.BaseEventListener
import com.pubnub.api.v2.callbacks.BaseStatusEmitter
import com.pubnub.api.v2.callbacks.BaseStatusListener
import com.pubnub.api.v2.entities.BaseChannel
import com.pubnub.api.v2.entities.BaseChannelGroup
import com.pubnub.api.v2.entities.BaseChannelMetadata
import com.pubnub.api.v2.entities.BaseUserMetadata
import com.pubnub.api.v2.subscriptions.BaseSubscription
import com.pubnub.api.v2.subscriptions.BaseSubscriptionSet
import com.pubnub.api.v2.subscriptions.SubscriptionOptions
import com.pubnub.internal.managers.ListenerManager
import com.pubnub.internal.subscribe.eventengine.configuration.EventEnginesConf
import java.util.UUID

abstract class BasePubNubImpl<
    EventListener : BaseEventListener,
    Subscription : BaseSubscription,
    Channel : BaseChannel,
    ChannelGroup : BaseChannelGroup,
    ChannelMetadata : BaseChannelMetadata,
    UserMetadata : BaseUserMetadata,
    SubscriptionSet : BaseSubscriptionSet,
    StatusListener : BaseStatusListener,
    > internal constructor(
    configuration: BasePNConfiguration,
    pnsdkName: String,
    eventEnginesConf: EventEnginesConf = EventEnginesConf(),
) : BasePubNub,
    BaseEventEmitter,
    BaseStatusEmitter {
    constructor(configuration: BasePNConfiguration, pnsdkName: String) : this(configuration, pnsdkName, EventEnginesConf())

    val listenerManager: ListenerManager = ListenerManager(this)
    val pubNubCore = PubNubCore(configuration, listenerManager, eventEnginesConf, pnsdkName)

    /**
     * The current version of the Kotlin SDK.
     */
    override val version: String
        get() = PubNubCore.SDK_VERSION

    override val timestamp: Int
        get() = PubNubCore.timestamp()

    override val baseUrl: String
        get() = pubNubCore.baseUrl()

    /**
     * Unique id of this PubNub instance.
     *
     * @see [BasePNConfiguration.includeInstanceIdentifier]
     */
    val instanceId: String
        get() = pubNubCore.instanceId

    companion object {
        /**
         * Generates random UUID to use. You should set a unique UUID to identify the user or the device that connects to PubNub.
         */
        @JvmStatic
        fun generateUUID() = "pn-${UUID.randomUUID()}"
    }

    override fun subscriptionSetOf(
        channels: Set,
        channelGroups: Set,
        options: SubscriptionOptions,
    ): SubscriptionSet {
        val subscriptionSet = subscriptionSetOf(subscriptions = emptySet())
        channels.forEach {
            subscriptionSet.add(channel(it).subscription(options))
        }
        channelGroups.forEach {
            subscriptionSet.add(channelGroup(it).subscription(options))
        }
        return subscriptionSet
    }

    /**
     * Remove a listener.
     *
     * @param listener The listener to be removed.
     */
    override fun removeListener(listener: Listener) {
        listenerManager.removeListener(listener)
    }

    /**
     * Removes all status and event listeners.
     */
    override fun removeAllListeners() {
        listenerManager.removeAllListeners()
    }

    /**
     * Force destroy the SDK to evict the connection pools and close executors.
     */
    override fun forceDestroy() {
        pubNubCore.forceDestroy()
    }

    /**
     * Destroy the SDK to cancel all ongoing requests and stop heartbeat timer.
     */
    override fun destroy() {
        pubNubCore.destroy()
    }

    override fun reconnect(timetoken: Long) {
        pubNubCore.reconnect(timetoken)
    }

    override fun parseToken(token: String): PNToken {
        return pubNubCore.parseToken(token)
    }

    override fun setToken(token: String?) {
        pubNubCore.setToken(token)
    }

    /**
     * Cancel any subscribe and heartbeat loops or ongoing re-connections.
     *
     * Monitor the results in [SubscribeCallback.status]
     */
    override fun disconnect() {
        pubNubCore.disconnect()
    }

    /**
     * Unsubscribe from all channels and all channel groups
     */
    override fun unsubscribeAll() {
        pubNubCore.unsubscribeAll()
    }
}