ObjFW
|
A class which provides methods to create and use UDP sockets. More...
#include <ObjFW/OFUDPSocket.h>
Instance Methods | |
(OFSocketAddress) | - bindToHost:port: |
Binds the socket to the specified host and port. | |
Instance Methods inherited from OFDatagramSocket | |
(size_t) | - receiveIntoBuffer:length:sender: |
Receives a datagram and stores it into the specified buffer. | |
(void) | - asyncReceiveIntoBuffer:length: |
Asynchronously receives a datagram and stores it into the specified buffer. | |
(void) | - asyncReceiveIntoBuffer:length:runLoopMode: |
Asynchronously receives a datagram and stores it into the specified buffer. | |
(void) | - asyncReceiveIntoBuffer:length:block: |
Asynchronously receives a datagram and stores it into the specified buffer. | |
(void) | - asyncReceiveIntoBuffer:length:runLoopMode:block: |
Asynchronously receives a datagram and stores it into the specified buffer. | |
(void) | - sendBuffer:length:receiver: |
Sends the specified datagram to the specified address. | |
(void) | - asyncSendData:receiver: |
Asynchronously sends the specified datagram to the specified address. | |
(void) | - asyncSendData:receiver:runLoopMode: |
Asynchronously sends the specified datagram to the specified address. | |
(void) | - asyncSendData:receiver:block: |
Asynchronously sends the specified datagram to the specified address. | |
(void) | - asyncSendData:receiver:runLoopMode:block: |
Asynchronously sends the specified datagram to the specified address. | |
(void) | - releaseSocketFromCurrentThread |
Releases the socket from the current thread. | |
(void) | - obtainSocketForCurrentThread |
Obtains the socket for the current thread. | |
(void) | - cancelAsyncRequests |
Cancels all pending asynchronous requests on the socket. | |
(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> | |
(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. | |
(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< OFUDPSocketDelegate > | delegate |
The delegate for asynchronous operations on the socket. | |
Properties inherited from OFDatagramSocket | |
bool | canBlock |
Whether the socket can block. | |
bool | canSendToBroadcastAddresses |
Whether the socket can send to broadcast addresses. | |
id< OFDatagramSocketDelegate > | 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 OFDatagramSocket | |
(instancetype) | + socket |
Returns a new, autoreleased OFDatagramSocket. | |
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 UDP sockets.
Addresses are of type OFSocketAddress. You can use the current thread's OFDNSResolver to create an address for a host / port pair, OFSocketAddressString to get the IP address string for an address and OFSocketAddressIPPort to get the port for an address. If you want to compare two addresses, you can use OFSocketAddressEqual and you can use OFSocketAddressHash to get a hash to use in e.g. OFMapTable.
- (OFSocketAddress) bindToHost: | (OFString *) | host | |
port: | (uint16_t) | port |
Binds the socket to the specified host and port.
host | The host to bind to. Use @"0.0.0.0" for IPv4 or @"::" for IPv6 to bind to all. |
port | The port to bind to. If the port is 0, an unused port will be chosen, which can be obtained using the return value. |
OFBindIPSocketFailedException | Binding failed |
OFAlreadyOpenException | The socket is already bound |
|
readwriteatomic |
The delegate for asynchronous operations on the socket.