|
ObjFW
|
A class which provides methods to create and use SPX sockets. More...
#import <ObjFW/OFSPXSocket.h>
Instance Methods | |
| (void) | - connectToNetwork:node:port: |
| Connect the OFSPXSocket to the specified destination. | |
| (void) | - asyncConnectToNetwork:node:port: |
| Asynchronously connect the OFSPXSocket to the specified destination. | |
| (void) | - asyncConnectToNetwork:node:port:runLoopMode: |
| Asynchronously connect the OFSPXSocket to the specified destination. | |
| (void) | - asyncConnectToNetwork:node:port:block: |
| Asynchronously connect the OFSPXSocket to the specified destination. | |
| (void) | - asyncConnectToNetwork:node:port:runLoopMode:block: |
| Asynchronously connect the OFSPXSocket to the specified destination. | |
| (OFSocketAddress) | - bindToNetwork:node:port: |
| Bind the socket to the specified network, node and port. | |
Instance Methods inherited from OFSequencedPacketSocket | |
| (size_t) | - receiveIntoBuffer:length: |
| Receives a packet and stores it into the specified buffer. | |
| (void) | - asyncReceiveIntoBuffer:length: |
| Asynchronously receives a packet and stores it into the specified buffer. | |
| (void) | - asyncReceiveIntoBuffer:length:runLoopMode: |
| Asynchronously receives a packet and stores it into the specified buffer. | |
| (void) | - asyncReceiveIntoBuffer:length:block: |
| Asynchronously receives a packet and stores it into the specified buffer. | |
| (void) | - asyncReceiveIntoBuffer:length:runLoopMode:block: |
| Asynchronously receives a packet and stores it into the specified buffer. | |
| (void) | - sendBuffer:length: |
| Sends the specified packet. | |
| (void) | - asyncSendData: |
| Asynchronously sends the specified packet. | |
| (void) | - asyncSendData:runLoopMode: |
| Asynchronously sends the specified packet. | |
| (void) | - asyncSendData:block: |
| Asynchronously sends the specified packet. | |
| (void) | - asyncSendData:runLoopMode:block: |
| Asynchronously sends the specified packet. | |
| (void) | - listenWithBacklog: |
| Listen on the socket. | |
| (void) | - listen |
| Listen on the socket. | |
| (instancetype) | - accept |
| Accept an incoming connection. | |
| (void) | - asyncAccept |
| Asynchronously accept an incoming connection. | |
| (void) | - asyncAcceptWithRunLoopMode: |
| Asynchronously accept an incoming connection. | |
| (void) | - asyncAcceptWithBlock: |
| Asynchronously accept an incoming connection. | |
| (void) | - asyncAcceptWithRunLoopMode:block: |
| Asynchronously accept an incoming connection. | |
| (void) | - cancelAsyncRequests |
| Cancels all pending asynchronous requests on the socket. | |
| (void) | - releaseSocketFromCurrentThread |
| Releases the socket from the current thread. | |
| (void) | - obtainSocketForCurrentThread |
| Obtains the socket for the current thread. | |
| (void) | - close |
| Closes the socket so that it can neither receive nor send any more datagrams. | |
Instance Methods inherited from OFObject | |
| (instancetype) | - init |
| Initializes an already allocated object. | |
| (nullable OFMethodSignature *) | - methodSignatureForSelector: |
| Returns the method signature for the specified selector. | |
| (void) | - dealloc |
| Deallocates the object. | |
| (void) | - performSelector:afterDelay: |
| Performs the specified selector after the specified delay. | |
| (void) | - performSelector:withObject:afterDelay: |
| Performs the specified selector with the specified object after the specified delay. | |
| (void) | - performSelector:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:waitUntilDone: |
| Performs the specified selector on the specified thread. | |
| (void) | - performSelector:onThread:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified object. | |
| (void) | - performSelector:onThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:waitUntilDone: |
| Performs the specified selector on the main thread. | |
| (void) | - performSelectorOnMainThread:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified object. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelector:onThread:afterDelay: |
| Performs the specified selector on the specified thread after the specified delay. | |
| (void) | - performSelector:onThread:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified object after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (nullable id) | - forwardingTargetForSelector: |
| This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. | |
| (void) | - doesNotRecognizeSelector: |
| Handles messages which are not understood by the receiver. | |
Instance Methods inherited from <OFObject> | |
| (Class) | - class |
| Returns the class of the object. | |
| (nullable Class) | - superclass |
| Returns the superclass of the object. | |
| (unsigned long) | - hash |
| Returns a hash for the object. | |
| (unsigned int) | - retainCount |
| Returns the retain count. | |
| (bool) | - isProxy |
| Returns whether the object is a proxy object. | |
| (bool) | - isKindOfClass: |
| Returns a boolean whether the object is of the specified kind. | |
| (bool) | - isMemberOfClass: |
| Returns a boolean whether the object is a member of the specified class. | |
| (bool) | - respondsToSelector: |
| Returns a boolean whether the object responds to the specified selector. | |
| (bool) | - conformsToProtocol: |
| Checks whether the object conforms to the specified protocol. | |
| (nullable IMP) | - methodForSelector: |
| Returns the implementation for the specified selector. | |
| (nullable id) | - performSelector: |
| Performs the specified selector. | |
| (nullable id) | - performSelector:withObject: |
| Performs the specified selector with the specified object. | |
| (nullable id) | - performSelector:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (bool) | - isEqual: |
| Checks two objects for equality. | |
| (instancetype) | - retain |
| Increases the retain count. | |
| (void) | - release |
| Decreases the retain count. | |
| (instancetype) | - autorelease |
| Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. | |
| (instancetype) | - self |
| Returns the receiver. | |
| (bool) | - allowsWeakReference |
| Returns whether the object allows a weak reference. | |
| (bool) | - retainWeakReference |
| Retain a weak reference to this object. | |
Instance Methods inherited from <OFCopying> | |
| (id) | - copy |
| Copies the object. | |
Properties | |
| id< OFSPXSocketDelegate > | delegate |
| The delegate for asynchronous operations on the socket. | |
Properties inherited from OFSequencedPacketSocket | |
| bool | canBlock |
| Whether the socket can block. | |
| bool | listening |
| Whether the socket is a listening socket. | |
| const OFSocketAddress * | remoteAddress |
| The remote address. | |
| id< OFSequencedPacketSocketDelegate > | delegate |
| The delegate for asynchronous operations on the socket. | |
Properties inherited from OFObject | |
| OFString * | className |
| The name of the object's class. | |
| OFString * | description |
| A description for the object. | |
Properties inherited from <OFReadyForReadingObserving> | |
| int | fileDescriptorForReading |
| The file descriptor for reading that should be checked by the OFKernelEventObserver. | |
Properties inherited from <OFReadyForWritingObserving> | |
| int | fileDescriptorForWriting |
| The file descriptor for writing that should be checked by the OFKernelEventObserver. | |
Additional Inherited Members | |
Class Methods inherited from OFSequencedPacketSocket | |
| (instancetype) | + socket |
| Returns a new, autoreleased OFSequencedPacketSocket. | |
Class Methods inherited from OFObject | |
| (void) | + load |
| A method which is called once when the class is loaded into the runtime. | |
| (void) | + unload |
| A method which is called when the class is unloaded from the runtime. | |
| (void) | + initialize |
| A method which is called the moment before the first call to the class is being made. | |
| (instancetype) | + alloc |
| Allocates memory for an instance of the class and sets up the memory pool for the object. | |
| (Class) | + class |
| Returns the class. | |
| (OFString *) | + className |
| Returns the name of the class as a string. | |
| (bool) | + isSubclassOfClass: |
| Returns a boolean whether the class is a subclass of the specified class. | |
| (nullable Class) | + superclass |
| Returns the superclass of the class. | |
| (bool) | + instancesRespondToSelector: |
| Checks whether instances of the class respond to a given selector. | |
| (bool) | + conformsToProtocol: |
| Checks whether the class conforms to a given protocol. | |
| (nullable IMP) | + instanceMethodForSelector: |
| Returns the implementation of the instance method for the specified selector. | |
| (nullable OFMethodSignature *) | + instanceMethodSignatureForSelector: |
| Returns the method signature of the instance method for the specified selector. | |
| (OFString *) | + description |
| Returns a description for the class, which is usually the class name. | |
| (nullable IMP) | + replaceClassMethod:withMethodFromClass: |
| Replaces a class method with a class method from another class. | |
| (nullable IMP) | + replaceInstanceMethod:withMethodFromClass: |
| Replaces an instance method with an instance method from another class. | |
| (void) | + inheritMethodsFromClass: |
| Adds all methods from the specified class to the class that is the receiver. | |
| (bool) | + resolveClassMethod: |
| Try to resolve the specified class method. | |
| (bool) | + resolveInstanceMethod: |
| Try to resolve the specified instance method. | |
| (id) | + copy |
| Returns the class. | |
A class which provides methods to create and use SPX sockets.
To connect to a server, create a socket and connect it. To create a server, create a socket, bind it and listen on it.
| - (void) asyncConnectToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
Asynchronously connect the OFSPXSocket to the specified destination.
| network | The network on which the node to connect to is |
| node | The node to connect to |
| port | The port (sometimes also called socket number) on the node to connect to |
| - (void) asyncConnectToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
| block: | (OFSPXSocketAsyncConnectBlock) | block | |
Asynchronously connect the OFSPXSocket to the specified destination.
| node | The node to connect to |
| network | The network on which the node to connect to is |
| port | The port (sometimes also called socket number) on the node to connect to |
| block | The block to execute once the connection has been established |
| - (void) asyncConnectToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
| runLoopMode: | (OFRunLoopMode) | runLoopMode | |
Asynchronously connect the OFSPXSocket to the specified destination.
| network | The network on which the node to connect to is |
| node | The node to connect to |
| port | The port (sometimes also called socket number) on the node to connect to |
| runLoopMode | The run loop mode in which to perform the async connect |
| - (void) asyncConnectToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
| runLoopMode: | (OFRunLoopMode) | runLoopMode | |
| block: | (OFSPXSocketAsyncConnectBlock) | block | |
Asynchronously connect the OFSPXSocket to the specified destination.
| node | The node to connect to |
| network | The network on which the node to connect to is |
| port | The port (sometimes also called socket number) on the node to connect to |
| runLoopMode | The run loop mode in which to perform the async connect |
| block | The block to execute once the connection has been established |
| - (OFSocketAddress) bindToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
Bind the socket to the specified network, node and port.
| network | The IPX network to bind to. 0 means the current network. |
| node | The IPX network to bind to. An all zero node means the computer's node. |
| port | The port (sometimes called socket number) to bind to. 0 means to pick one and return via the returned socket address. |
| OFBindIPXSocketFailedException | Binding failed |
| OFAlreadyOpenException | The socket is already connected or bound |
| - (void) connectToNetwork: | (uint32_t) | network | |
| node: | (const unsigned char [ IPX_NODE_LEN]) | node | |
| port: | (uint16_t) | port | |
Connect the OFSPXSocket to the specified destination.
| network | The network on which the node to connect to is |
| node | The node to connect to |
| port | The port (sometimes also called socket number) on the node to connect to |
| OFConnectSPXSocketFailedException | Connecting failed |
| OFAlreadyOpenException | The socket is already connected or bound |
|
readwriteatomic |
The delegate for asynchronous operations on the socket.