ObjFW
|
A base class for datagram sockets. More...
#include <ObjFW/OFDatagramSocket.h>
Instance Methods | |
(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. | |
Class Methods | |
(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. | |
Properties | |
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. | |
A base class for datagram sockets.
- (void) asyncReceiveIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length |
Asynchronously receives a datagram and stores it into the specified buffer.
If the buffer is too small, the datagram is truncated.
buffer | The buffer to write the datagram to |
length | The length of the buffer |
- (void) asyncReceiveIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
block: | (OFDatagramSocketAsyncReceiveBlock) | block |
Asynchronously receives a datagram and stores it into the specified buffer.
If the buffer is too small, the datagram is truncated.
buffer | The buffer to write the datagram to |
length | The length of the buffer |
block | The block to call when the datagram has been received. If the block returns true, it will be called again with the same buffer and maximum length when more datagrams have been received. If you want the next method in the queue to handle the datagram received next, you need to return false from the method. |
- (void) asyncReceiveIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
runLoopMode: | (OFRunLoopMode) | runLoopMode |
Asynchronously receives a datagram and stores it into the specified buffer.
If the buffer is too small, the datagram is truncated.
buffer | The buffer to write the datagram to |
length | The length of the buffer |
runLoopMode | The run loop mode in which to perform the asynchronous receive |
- (void) asyncReceiveIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
runLoopMode: | (OFRunLoopMode) | runLoopMode | |
block: | (OFDatagramSocketAsyncReceiveBlock) | block |
Asynchronously receives a datagram and stores it into the specified buffer.
If the buffer is too small, the datagram is truncated.
buffer | The buffer to write the datagram to |
length | The length of the buffer |
runLoopMode | The run loop mode in which to perform the asynchronous receive |
block | The block to call when the datagram has been received. If the block returns true, it will be called again with the same buffer and maximum length when more datagrams have been received. If you want the next method in the queue to handle the datagram received next, you need to return false from the method. |
- (void) asyncSendData: | (OFData *) | data | |
receiver: | (const OFSocketAddress *) | receiver |
Asynchronously sends the specified datagram to the specified address.
data | The data to send as a datagram |
receiver | A pointer to an OFSocketAddress to which the datagram should be sent. The receiver is copied. |
- (void) asyncSendData: | (OFData *) | data | |
receiver: | (const OFSocketAddress *) | receiver | |
block: | (OFDatagramSocketAsyncSendDataBlock) | block |
Asynchronously sends the specified datagram to the specified address.
data | The data to send as a datagram |
receiver | A pointer to an OFSocketAddress to which the datagram should be sent. The receiver is copied. |
block | The block to call when the packet has been sent. It should return the data for the next send with the same callback or nil if it should not repeat. |
- (void) asyncSendData: | (OFData *) | data | |
receiver: | (const OFSocketAddress *) | receiver | |
runLoopMode: | (OFRunLoopMode) | runLoopMode |
Asynchronously sends the specified datagram to the specified address.
data | The data to send as a datagram |
receiver | A pointer to an OFSocketAddress to which the datagram should be sent. The receiver is copied. |
runLoopMode | The run loop mode in which to perform the asynchronous send |
- (void) asyncSendData: | (OFData *) | data | |
receiver: | (const OFSocketAddress *) | receiver | |
runLoopMode: | (OFRunLoopMode) | runLoopMode | |
block: | (OFDatagramSocketAsyncSendDataBlock) | block |
Asynchronously sends the specified datagram to the specified address.
data | The data to send as a datagram |
receiver | A pointer to an OFSocketAddress to which the datagram should be sent. The receiver is copied. |
runLoopMode | The run loop mode in which to perform the asynchronous send |
block | The block to call when the packet has been sent. It should return the data for the next send with the same callback or nil if it should not repeat. |
- (void) close |
Closes the socket so that it can neither receive nor send any more datagrams.
OFNotOpenException | The socket is not open |
- (void) obtainSocketForCurrentThread |
Obtains the socket for the current thread.
This is necessary on some platforms in order to allow a different thread to use the socket, e.g. on AmigaOS, but you should call it on all operating systems before using the socket from a different thread.
You must only call this method after releaseSocketFromCurrentThread has been called from a different thread.
- (size_t) receiveIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
sender: | (nullable OFSocketAddress *) | sender |
Receives a datagram and stores it into the specified buffer.
If the buffer is too small, the datagram is truncated.
buffer | The buffer to write the datagram to |
length | The length of the buffer |
sender | A pointer to an OFSocketAddress, which will be set to the address of the sender |
OFReadFailedException | Receiving failed |
OFNotOpenException | The socket is not open |
- (void) releaseSocketFromCurrentThread |
Releases the socket from the current thread.
This is necessary on some platforms in order to allow a different thread to use the socket, e.g. on AmigaOS, but you should call it on all operating systems before using the socket from a different thread.
After calling this method, you must no longer use the socket until obtainSocketForCurrentThread has been called.
- (void) sendBuffer: | (const void *) | buffer | |
length: | (size_t) | length | |
receiver: | (const OFSocketAddress *) | receiver |
Sends the specified datagram to the specified address.
buffer | The buffer to send as a datagram |
length | The length of the buffer |
receiver | A pointer to an OFSocketAddress to which the datagram should be sent |
OFWriteFailedException | Sending failed |
OFNotOpenException | The socket is not open |
+ (instancetype) socket |
Returns a new, autoreleased OFDatagramSocket.
|
readwritenonatomicassign |
Whether the socket can block.
By default, a socket can block.
OFGetOptionFailedException | The option could not be retrieved |
OFSetOptionFailedException | The option could not be set |
|
readwritenonatomicassign |
Whether the socket can send to broadcast addresses.
OFGetOptionFailedException | The option could not be retrieved |
OFSetOptionFailedException | The option could not be set |
|
readwriteatomic |
The delegate for asynchronous operations on the socket.