View on GitHub
PlanetKitDataSessionControllable Protocol Reference
PlanetKitDataSessionControllable
@objc
public protocol PlanetKitDataSessionControllableA protocol that defines the controllable behavior of a data session in PlanetKit.
-
Creates an outbound data session with the specified stream ID, type, delegate, and completion closure.
Declaration
Swift
func makeOutboundDataSession(streamId: PlanetKitDataSessionStreamId, type: PlanetKitDataSessionType, delegate: PlanetKitOutboundDataSessionDelegate, completion: @escaping PlanetKitOutboundDataSession.Completion)Parameters
streamIdThe stream ID of the data session.
typeThe type of the data session.
delegateThe delegate object that will receive callbacks from the data session.
completionThe closure that will be called when the data session creation is completed.
-
Creates an inbound data session with the specified stream ID, delegate, and completion closure.
Declaration
Swift
func makeInboundDataSession(streamId: PlanetKitDataSessionStreamId, delegate: PlanetKitInboundDataSessionDelegate, completion: @escaping PlanetKitInboundDataSession.Completion)Parameters
streamIdThe stream ID of the data session.
delegateThe delegate object that will receive callbacks from the data session.
completionThe closure that will be called when the data session creation is completed.
-
Unsupports an inbound data session with the specified stream ID.
Declaration
Swift
func unsupportInboundDataSession(streamId: PlanetKitDataSessionStreamId)Parameters
streamIdThe stream ID of the data session to be unsupported.
-
Retrieves the outbound data session with the specified stream ID.
Declaration
Swift
func getOutboundDataSession(streamId: PlanetKitDataSessionStreamId) -> PlanetKitOutboundDataSession?Parameters
streamIdThe stream ID of the data session.
Return Value
The outbound data session associated with the stream ID, or
nilif not found. -
Retrieves the inbound data session with the specified stream ID.
Declaration
Swift
func getInboundDataSession(streamId: PlanetKitDataSessionStreamId) -> PlanetKitInboundDataSession?Parameters
streamIdThe stream ID of the data session.
Return Value
The inbound data session associated with the stream ID, or
nilif not found.