diff --git a/README.md b/README.md index 7bfbddf..67b5190 100644 --- a/README.md +++ b/README.md @@ -129,18 +129,18 @@ Options Methods ------- 1. `on(event: String, callback: ((data: [AnyObject], ack: SocketAckEmitter?) -> Void))` - Adds a handler for an event. Items are passed by an array. `ack` can be used to send an ack when one is requested. See example. -3. `onAny(callback:((event: String, items: AnyObject?)) -> Void)` - Adds a handler for all events. It will be called on any received event. -4. `emit(event: String, _ items: AnyObject...)` - Sends a message. Can send multiple items. -5. `emit(event: String, withItems items: [AnyObject])` - `emit` for Objective-C -6. `emitWithAck(event: String, _ items: AnyObject...) -> (timeoutAfter: UInt64, callback: (NSArray?) -> Void) -> Void` - Sends a message that requests an acknowledgement from the server. Returns a function which you can use to add a handler. See example. Note: The message is not sent until you call the returned function. -7. `emitWithAck(event: String, withItems items: [AnyObject]) -> (UInt64, (NSArray?) -> Void) -> Void` - `emitWithAck` for Objective-C. Note: The message is not sent until you call the returned function. -8. `connect()` - Establishes a connection to the server. A "connect" event is fired upon successful connection. -9. `connect(timeoutAfter timeoutAfter: Int, withTimeoutHandler handler: (() -> Void)?)` - Connect to the server. If it isn't connected after timeoutAfter seconds, the handler is called. -10. `close()` - Closes the socket. Once a socket is closed it should not be reopened. -11. `reconnect()` - Causes the client to reconnect to the server. -12. `joinNamespace()` - Causes the client to join nsp. Shouldn't need to be called unless you change nsp manually. -13. `leaveNamespace()` - Causes the client to leave the nsp and go back to / -14. `once(event: String, callback: NormalCallback)` - Adds a handler that will only be executed once. +2. `onAny(callback:((event: String, items: AnyObject?)) -> Void)` - Adds a handler for all events. It will be called on any received event. +3. `emit(event: String, _ items: AnyObject...)` - Sends a message. Can send multiple items. +4. `emit(event: String, withItems items: [AnyObject])` - `emit` for Objective-C +5. `emitWithAck(event: String, _ items: AnyObject...) -> (timeoutAfter: UInt64, callback: (NSArray?) -> Void) -> Void` - Sends a message that requests an acknowledgement from the server. Returns a function which you can use to add a handler. See example. Note: The message is not sent until you call the returned function. +6. `emitWithAck(event: String, withItems items: [AnyObject]) -> (UInt64, (NSArray?) -> Void) -> Void` - `emitWithAck` for Objective-C. Note: The message is not sent until you call the returned function. +7. `connect()` - Establishes a connection to the server. A "connect" event is fired upon successful connection. +8. `connect(timeoutAfter timeoutAfter: Int, withTimeoutHandler handler: (() -> Void)?)` - Connect to the server. If it isn't connected after timeoutAfter seconds, the handler is called. +9. `close()` - Closes the socket. Once a socket is closed it should not be reopened. +10. `reconnect()` - Causes the client to reconnect to the server. +11. `joinNamespace()` - Causes the client to join nsp. Shouldn't need to be called unless you change nsp manually. +12. `leaveNamespace()` - Causes the client to leave the nsp and go back to / +13. `once(event: String, callback: NormalCallback)` - Adds a handler that will only be executed once. Client Events ------