Fix some documentation marks
This commit is contained in:
parent
96ce620f69
commit
943e94ed0e
@ -27,6 +27,8 @@ import Foundation
|
|||||||
|
|
||||||
/// The status of an ack.
|
/// The status of an ack.
|
||||||
public enum SocketAckStatus : String {
|
public enum SocketAckStatus : String {
|
||||||
|
// MARK: Cases
|
||||||
|
|
||||||
/// The ack timed out.
|
/// The ack timed out.
|
||||||
case noAck = "NO ACK"
|
case noAck = "NO ACK"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -129,6 +129,8 @@ public struct SocketIOClientConfiguration : ExpressibleByArrayLiteral, Collectio
|
|||||||
|
|
||||||
/// Declares that a type can set configs from a `SocketIOClientConfiguration`.
|
/// Declares that a type can set configs from a `SocketIOClientConfiguration`.
|
||||||
public protocol ConfigSettable {
|
public protocol ConfigSettable {
|
||||||
|
// MARK: Methods
|
||||||
|
|
||||||
/// Called when an `ConfigSettable` should set/update its configs from a given configuration.
|
/// Called when an `ConfigSettable` should set/update its configs from a given configuration.
|
||||||
///
|
///
|
||||||
/// - parameter config: The `SocketIOClientConfiguration` that should be used to set/update configs.
|
/// - parameter config: The `SocketIOClientConfiguration` that should be used to set/update configs.
|
||||||
|
|||||||
@ -26,7 +26,7 @@ import Foundation
|
|||||||
|
|
||||||
/// Protocol that is used to implement socket.io polling support
|
/// Protocol that is used to implement socket.io polling support
|
||||||
public protocol SocketEnginePollable : SocketEngineSpec {
|
public protocol SocketEnginePollable : SocketEngineSpec {
|
||||||
/// MARK: Properties
|
// MARK: Properties
|
||||||
|
|
||||||
/// `true` If engine's session has been invalidated.
|
/// `true` If engine's session has been invalidated.
|
||||||
var invalidated: Bool { get }
|
var invalidated: Bool { get }
|
||||||
@ -51,6 +51,8 @@ public protocol SocketEnginePollable : SocketEngineSpec {
|
|||||||
/// **Do not touch this directly**
|
/// **Do not touch this directly**
|
||||||
var waitingForPost: Bool { get set }
|
var waitingForPost: Bool { get set }
|
||||||
|
|
||||||
|
// MARK: Methods
|
||||||
|
|
||||||
/// Call to send a long-polling request.
|
/// Call to send a long-polling request.
|
||||||
///
|
///
|
||||||
/// You shouldn't need to call this directly, the engine should automatically maintain a long-poll request.
|
/// You shouldn't need to call this directly, the engine should automatically maintain a long-poll request.
|
||||||
|
|||||||
@ -28,6 +28,8 @@ import Starscream
|
|||||||
|
|
||||||
/// Specifies a SocketEngine.
|
/// Specifies a SocketEngine.
|
||||||
@objc public protocol SocketEngineSpec {
|
@objc public protocol SocketEngineSpec {
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
/// The client for this engine.
|
/// The client for this engine.
|
||||||
var client: SocketEngineClient? { get set }
|
var client: SocketEngineClient? { get set }
|
||||||
|
|
||||||
@ -85,6 +87,8 @@ import Starscream
|
|||||||
/// The WebSocket for this engine.
|
/// The WebSocket for this engine.
|
||||||
var ws: WebSocket? { get }
|
var ws: WebSocket? { get }
|
||||||
|
|
||||||
|
// MARK: Initializers
|
||||||
|
|
||||||
/// Creates a new engine.
|
/// Creates a new engine.
|
||||||
///
|
///
|
||||||
/// - parameter client: The client for this engine.
|
/// - parameter client: The client for this engine.
|
||||||
@ -92,6 +96,8 @@ import Starscream
|
|||||||
/// - parameter options: The options for this engine.
|
/// - parameter options: The options for this engine.
|
||||||
init(client: SocketEngineClient, url: URL, options: [String: Any]?)
|
init(client: SocketEngineClient, url: URL, options: [String: Any]?)
|
||||||
|
|
||||||
|
// MARK: Methods
|
||||||
|
|
||||||
/// Starts the connection to the server.
|
/// Starts the connection to the server.
|
||||||
func connect()
|
func connect()
|
||||||
|
|
||||||
|
|||||||
@ -28,6 +28,8 @@ import Starscream
|
|||||||
|
|
||||||
/// Protocol that is used to implement socket.io WebSocket support
|
/// Protocol that is used to implement socket.io WebSocket support
|
||||||
public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate {
|
public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate {
|
||||||
|
// MARK: Methods
|
||||||
|
|
||||||
/// Sends an engine.io message through the WebSocket transport.
|
/// Sends an engine.io message through the WebSocket transport.
|
||||||
///
|
///
|
||||||
/// You shouldn't call this directly, instead call the `write` method on `SocketEngine`.
|
/// You shouldn't call this directly, instead call the `write` method on `SocketEngine`.
|
||||||
|
|||||||
@ -24,8 +24,6 @@ import Foundation
|
|||||||
|
|
||||||
/// Defines that a type will be able to parse socket.io-protocol messages.
|
/// Defines that a type will be able to parse socket.io-protocol messages.
|
||||||
public protocol SocketParsable : class {
|
public protocol SocketParsable : class {
|
||||||
// MARK: Properties
|
|
||||||
|
|
||||||
// MARK: Methods
|
// MARK: Methods
|
||||||
|
|
||||||
/// Called when the engine has received some binary data that should be attached to a packet.
|
/// Called when the engine has received some binary data that should be attached to a packet.
|
||||||
@ -60,6 +58,8 @@ public enum SocketParsableError : Error {
|
|||||||
|
|
||||||
/// Says that a type will be able to buffer binary data before all data for an event has come in.
|
/// Says that a type will be able to buffer binary data before all data for an event has come in.
|
||||||
public protocol SocketDataBufferable : class {
|
public protocol SocketDataBufferable : class {
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
/// A list of packets that are waiting for binary data.
|
/// A list of packets that are waiting for binary data.
|
||||||
///
|
///
|
||||||
/// The way that socket.io works all data should be sent directly after each packet.
|
/// The way that socket.io works all data should be sent directly after each packet.
|
||||||
|
|||||||
@ -27,6 +27,8 @@ import Starscream
|
|||||||
|
|
||||||
/// A wrapper around Starscream's SSLSecurity that provides a minimal Objective-C interface.
|
/// A wrapper around Starscream's SSLSecurity that provides a minimal Objective-C interface.
|
||||||
open class SSLSecurity : NSObject {
|
open class SSLSecurity : NSObject {
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
/// The internal Starscream SSLSecurity.
|
/// The internal Starscream SSLSecurity.
|
||||||
public let security: Starscream.SSLSecurity
|
public let security: Starscream.SSLSecurity
|
||||||
|
|
||||||
@ -34,6 +36,8 @@ open class SSLSecurity : NSObject {
|
|||||||
self.security = security
|
self.security = security
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// MARK: Methods
|
||||||
|
|
||||||
/// Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL
|
/// Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL
|
||||||
/// pinning validation
|
/// pinning validation
|
||||||
///
|
///
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user