CFMessagePort 객체는 주로 메시지 기반의 단방향 통신을 위해서 설계되었으며 로컬 장비 상에서 다중 쓰레드 및 프로세스들 간에 임의의 데이터를 전달하는 통신 채널을 제공합니다. 즉, CFMessagePort는 서로 다른 애플리케이션, 또는 애플리케이션과 프레임워크, 또는 서로 다른 프레임워크 사이의 통신을 제공합니다.
CFMessagePort는 이름을 기반으로 메시지 포트를 찾아서 특정 메시지 포트로 메시지를 보내려는 다른 프로세스가 해당 포트를 찾을 수 있게 합니다. CFMessagePort는 아래의 두 개의 형태를 사용하여 메시지를 주고 받습니다.
Local CFMessagePort: 동일한 프로세스 내에서 사용됩니다. 로컬 메시지 포트는 동인한 프로세스 내에서 메시지를 보낼 수 있도록 합니다.
Remote CFMessagePort: 다른 프로세스로 메시지를 보낼 때 사용됩니다. 원격 메시지 포트를 사용하여 다른 프로세스의 로컬 메시지 포트로 메시지를 보낼 수 있습니다.
CFMessagePort는 아래의 주요한 메서드를 기반으로 동작합니다.
CFMessagePortCreateLocal: 로컬 메시지 포트를 생성합니다.
CFMessagePortCreateRemote: 원격 메시지 포트를 생성합니다.
CFMessagePortSendRequest: 원격 포트에 메시지를 전송합니다.
CFMessagePortSetInvalidationCallBack: 로컬 메시지 포트 또는 원격 메시지 포트가 무효화될 때 호출되는 콜백을 설정합니다.
CFMessagePortInvalidate: 로컬 메시지 포트 또는 원격 메시지 포트를 무효화합니다.
CFMessagePortIsValid: 로컬 메시지 포트 또는 원격 메시지 포트가 유효한지 확인합니다.
/*
* Copyright (c) 2023 Universal-SystemKit. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#if os(iOS) || os(macOS)
import Foundation
import CoreFoundation
public class SKMessagePort: SKClass {
// MARK: - Object Properties
public static var label: String = "com.SystemKit.SKMessagePort"
public static var identifier: String = "368027F0-C77F-4F81-B352-F92B7B0370DB"
private var pointee: Optional<SKMessagePortContextPointer> = nil
private var messagePort: Optional<CFMessagePort>
// MARK: - Computed Properties
public var messagePortStatus: Optional<SKMessagePortStatus> {
return SKMessagePortStatus(messagePort: self.messagePort)
}
// MARK: - Initalize
public init(localPortName: String, info: AnyObject,
_ callback: @escaping CFMessagePortCallBack,
_ callout: @escaping CFMessagePortInvalidationCallBack) {
self.pointee = SKMessagePort.createMutablePointer(instance: info)
self.messagePort = SKMessagePort.createLocalMessagePort(portName: localPortName, info: self.pointee,
callback, callout)
}
public init(remotePortName: String,
_ callout: @escaping CFMessagePortInvalidationCallBack) {
self.messagePort = SKMessagePort.createRemoteMessagePort(portName: remotePortName, callout)
}
}
// MARK: - Private Extension SKMessagePort
private extension SKMessagePort {
/// Returns a local CFMessagePort object.
static func createLocalMessagePort(portName: String,
info: Optional<SKMessagePortContextPointer>,
_ callback: @escaping CFMessagePortCallBack,
_ callout: @escaping CFMessagePortInvalidationCallBack) -> Optional<CFMessagePort> {
logger.info("[SKMessagePort] CFMessageLocalPort has been created.")
var context = CFMessagePortContext(version: CFIndex.zero, info: info,
retain: nil, release: nil, copyDescription: nil)
var shouldFreeInfo: DarwinBoolean = false
// 동일한 프로세스 내에서 메시지를 보낼 때 사용하는 로컬 메시지 포트를 생성합니다.
guard let result = CFMessagePortCreateLocal(nil, portName as CFString,
callback, &context, &shouldFreeInfo) else {
logger.error("[SKMessagePort] Failed to create a CFMessageLocalPort object.")
info?.deallocate()
return nil
}
// Sets the callback function invoked when a CFMessagePort object is invalidated.
CFMessagePortSetInvalidationCallBack(result, callout)
return result
}
/// Returns a CFMessagePort object connected to a remote port.
static func createRemoteMessagePort(portName: String,
_ callout: @escaping CFMessagePortInvalidationCallBack) -> Optional<CFMessagePort> {
logger.info("[SKMessagePort] CFMessageRemotePort has been created.")
// 다른 프로세스로 메시지를 보낼 때 사용하는 원격 메시지 포트를 생성합니다.
guard let result = CFMessagePortCreateRemote(nil, portName as CFString) else {
logger.error("[SKMessagePort] Failed to create a CFMessageRemotePort object.")
return nil
}
// Sets the callback function invoked when a CFMessagePort object is invalidated.
CFMessagePortSetInvalidationCallBack(result, callout)
return result
}
static func createMutablePointer<T: AnyObject>(instance: T) -> UnsafeMutablePointer<T> {
let pointer = UnsafeMutablePointer<T>.allocate(capacity: 1)
pointer.initialize(to: instance)
return pointer
}
final func getVaildMessagePort() -> Optional<CFMessagePort> {
guard let targetPort: CFMessagePort = self.messagePort else {
logger.error("[SKMessagePort] The CFMessagePort is invalid.")
return nil
}
// Returns bool that indicates whether a CFMessagePort is valid and able to send or receive messages.
guard CFMessagePortIsValid(targetPort) else {
logger.error("[SKMessagePort] The CFMessagePort object is unable to perform normal operations.")
return nil
}
return targetPort
}
}
// MARK: - Public Extension SKMessagePort
public extension SKMessagePort {
@discardableResult
final func invalidate() -> Bool {
logger.info("[SKMessagePort] Performing invalidate on the CFMessagePort.")
// CFMessagePort 유효성을 확인하여 CFMessagePort 객체를 가져옵니다.
guard let targetPort = getVaildMessagePort() else { return false }
// Deallocates the memory block previously allocated at this pointer.
self.pointee?.deallocate()
// Invalidates a CFMessagePort object, stopping it from receiving or sending any more messages.
CFMessagePortInvalidate(targetPort)
// 정상적으로 CFMessagePort 객체가 소멸이 되었는 경우에는 true, 소멸되지 않은 경우에는 false를 반환합니다.
return !CFMessagePortIsValid(targetPort)
}
@discardableResult
final func listen(queue: DispatchQueue) -> Bool {
logger.info("[SKMessagePort] Performing the listen on the CFMessagePort by DispatchQueue.")
// CFMessagePort 유효성을 확인하여 CFMessagePort 객체를 가져옵니다.
guard let targetPort = getVaildMessagePort() else { return false }
// CFMessagePort is not a local port, queue cannot be set.
if CFMessagePortIsRemote(targetPort) { return false }
// Schedules callbacks for the specified message port on the specified dispatch queue.
CFMessagePortSetDispatchQueue(targetPort, queue)
return CFMessagePortIsValid(targetPort)
}
@discardableResult
final func listen(runLoop: RunLoop) -> Bool {
logger.info("[SKMessagePort] Performing the listen on the CFMessagePort by CFRunLoop.")
// CFMessagePort 유효성을 확인하여 CFMessagePort 객체를 가져옵니다.
guard let targetPort = getVaildMessagePort() else { return false }
// CFMessagePort is not a local port, RunLoop cannot be set.
if CFMessagePortIsRemote(targetPort) { return false }
// Adds a CFRunLoopSource object to a run loop mode.
CFRunLoopAddSource(runLoop.getCFRunLoop(),
CFMessagePortCreateRunLoopSource(nil, targetPort, CFIndex.zero),
CFRunLoopMode.commonModes)
return CFMessagePortIsValid(targetPort)
}
@discardableResult
final func send(messageID: Int32, message: Data,
sendTimeout: CFTimeInterval, recvTimeout: CFTimeInterval) -> SKMessagePortRequestError {
// CFMessagePort 유효성을 확인하여 CFMessagePort 객체를 가져옵니다.
guard let targetPort = getVaildMessagePort() else {
return .failure(SKMessagePortSendRequestErrorCode.invalid)
}
// 전송하고자 하는 데이터가 비어있는 경우에는 전송하지 않습니다.
if message.isEmpty {
return .failure(SKMessagePortSendRequestErrorCode.transportError)
}
// Sends a message to a remote CFMessagePort object.
let error = CFMessagePortSendRequest(targetPort, messageID, message as CFData, sendTimeout, recvTimeout, nil, nil)
return SKMessagePortSendRequestErrorCode.getMessagePortRequestError(error)
}
}
#endif
댓글