OFSCTPSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFSequencedPacketSocket.h"
#import "OFRunLoop.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFSCTPSocket;
@class OFString;
 
typedef OFConstantString *OFSCTPMessageInfoKey;
 
typedef OFDictionary OF_GENERIC(OFSCTPMessageInfoKey, id) *OFSCTPMessageInfo;
 
#ifdef __cplusplus
extern "C" {
#endif
extern const OFSCTPMessageInfoKey OFSCTPStreamID;
 
extern const OFSCTPMessageInfoKey OFSCTPPPID;
 
extern const OFSCTPMessageInfoKey OFSCTPUnordered;
#ifdef __cplusplus
}
#endif
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFSCTPSocketConnectedHandler)(OFSCTPSocket *socket,
    OFString *host, uint16_t port, id _Nullable exception);
 
typedef bool (^OFSCTPSocketMessageReceivedHandler)(OFSCTPSocket *socket,
    void *buffer, size_t length, OFSCTPMessageInfo _Nullable info,
    id _Nullable exception);
 
typedef OFData *_Nullable (^OFSCTPSocketDataSentHandler)(OFSCTPSocket *socket,
    OFData *data, OFSCTPMessageInfo _Nullable info, id _Nullable exception);
#endif
 
@protocol OFSCTPSocketDelegate <OFSequencedPacketSocketDelegate>
@optional
-     (void)socket: (OFSCTPSocket *)socket
  didConnectToHost: (OFString *)host
          port: (uint16_t)port
     exception: (nullable id)exception;
 
-     (bool)socket: (OFSCTPSocket *)socket
  didReceiveIntoBuffer: (void *)buffer
        length: (size_t)length
          info: (nullable OFSCTPMessageInfo)info
         exception: (nullable id)exception;
 
- (nullable OFData *)socket: (OFSCTPSocket *)socket
        didSendData: (OFData *)data
               info: (nullable OFSCTPMessageInfo)info
          exception: (nullable id)exception;
@end
 
@interface OFSCTPSocket: OFSequencedPacketSocket
{
    OF_RESERVE_IVARS(OFSCTPSocket, 4)
}
 
@property (nonatomic) bool canDelaySendingMessages;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFSCTPSocketDelegate> delegate;
 
- (void)connectToHost: (OFString *)host port: (uint16_t)port;
 
- (void)asyncConnectToHost: (OFString *)host port: (uint16_t)port;
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           handler: (OFSCTPSocketConnectedHandler)handler;
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           runLoopMode: (OFRunLoopMode)runLoopMode
           handler: (OFSCTPSocketConnectedHandler)handler;
#endif
 
- (OFSocketAddress)bindToHost: (OFString *)host port: (uint16_t)port;
 
- (size_t)receiveIntoBuffer: (void *)buffer
             length: (size_t)length
               info: (__autoreleasing _Nullable OFSCTPMessageInfo
                 *_Nullable)info;
 
- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
                length: (size_t)length;
 
- (void)asyncReceiveWithInfoIntoBuffer: (void *)buffer
                length: (size_t)length
               runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)
    asyncReceiveWithInfoIntoBuffer: (void *)buffer
                length: (size_t)length
               handler: (OFSCTPSocketMessageReceivedHandler)handler;
 
- (void)
    asyncReceiveWithInfoIntoBuffer: (void *)buffer
                length: (size_t)length
               runLoopMode: (OFRunLoopMode)runLoopMode
               handler: (OFSCTPSocketMessageReceivedHandler)handler;
#endif
 
- (void)sendBuffer: (const void *)buffer
        length: (size_t)length
          info: (nullable OFSCTPMessageInfo)info;
 
- (void)asyncSendData: (OFData *)data info: (nullable OFSCTPMessageInfo)info;
 
- (void)asyncSendData: (OFData *)data
         info: (nullable OFSCTPMessageInfo)info
      runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncSendData: (OFData *)data
         info: (nullable OFSCTPMessageInfo)info
          handler: (OFSCTPSocketDataSentHandler)handler;
 
- (void)asyncSendData: (OFData *)data
         info: (nullable OFSCTPMessageInfo)info
      runLoopMode: (OFRunLoopMode)runLoopMode
          handler: (OFSCTPSocketDataSentHandler)handler;
#endif
@end
 
OF_ASSUME_NONNULL_END