Socket.h

//
// $Id: Socket.h,v 1.19 2007/04/15 23:32:57 will_mason Exp $
//
// vi: set ft=objc:

/*
 * ObjectiveLib - a library of containers and algorithms for Objective-C
 *
 * Copyright (c) 2004-2007
 * Will Mason
 *
 * Portions:
 *
 * Copyright (c) 1994
 * Hewlett-Packard Company
 *
 * Copyright (c) 1996,1997
 * Silicon Graphics Computer Systems, Inc.
 *
 * Copyright (c) 1997
 * Moscow Center for SPARC Technology
 *
 * Copyright (c) 1999 
 * Boris Fomitchev
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * You may contact the author at will_mason@users.sourceforge.net.
 */

#if !defined(SOCKET_OL_GUARD)
#define SOCKET_OL_GUARD

#include <ObjectiveLib/SocketAddress.h>

@class OLInStream;
@class OLOutStream;

@interface OLSocket :
#if defined(OL_NO_OPENSTEP)
    Object
#else
    NSObject
#endif
{
@protected
    OLInStream*         inStream;

    OLOutStream*        outStream;

    int                 fd;
}

/* @{ */
#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (BOOL) allowsBroadcast;

- (void) close;

- (BOOL) dontRoute;

- (BOOL) hasReusePortSupport;

- (OLInStream*) inStream;

- (BOOL) keepAlive;

- (unsigned) linger;

- (OLSocketAddress*) localAddress;

- (BOOL) outOfBandInline;

- (OLOutStream*) outStream;

- (unsigned) receiveBufferSize;

- (unsigned) receiveLowWaterMark;

- (unsigned) receiveTimeOut;

- (OLSocketAddress*) remoteAddress;

- (BOOL) reuseAddress;

- (BOOL) reusePort;

- (unsigned) sendBufferSize;

- (unsigned) sendLowWaterMark;

- (unsigned) sendTimeOut;

- (void) setAllowsBroadcast: (BOOL)state;

- (void) setDontRoute: (BOOL)state;

- (void) setKeepAlive: (BOOL)state;

- (void) setLinger: (unsigned)value;

- (void) setOutOfBandInline: (BOOL)state;

- (void) setReceiveBufferSize: (unsigned)size;

- (void) setReceiveLowWaterMark: (unsigned)value;

- (void) setReceiveTimeOut: (unsigned)value;

- (void) setReuseAddress: (BOOL)state;

- (void) setReusePort: (BOOL)state;

- (void) setSendBufferSize: (unsigned)size;

- (void) setSendLowWaterMark: (unsigned)value;

- (void) setSendTimeOut: (unsigned)value;

- (void) shutdownRead;

- (void) shutdownWrite;

- (int) socketType;

@end

@interface OLBindableSocket : OLSocket
{
}

- (void) bindToAddress: (OLSocketAddress*)address;

@end

@interface OLServerSocket : OLBindableSocket
{
@protected
    unsigned queueLength;
}

/* @{ */
- (id) init;

- (id) initWithLocalAddress: (OLSocketAddress*)address;

- (id) initWithLocalAddress: (OLSocketAddress*)address queueLength: (unsigned)qLen;

- (id) initWithQueueLength: (unsigned)qLen;
/* @} */

- (OLSocket*) acceptConnection;
- (void) bindToAddress: (OLSocketAddress*)address;

- (unsigned) queueLength;

@end

@interface OLClientSocket : OLBindableSocket
{
}

/* @{ */
- (id) init;

- (id) initWithRemoteAddress: (OLSocketAddress*)remote;

- (id) initWithRemoteAddress: (OLSocketAddress*)remote localAddress: (OLSocketAddress*)local;
/* @} */

- (void) connectToAddress: (OLSocketAddress*)address;

@end

@interface OLInternetServerSocket : OLServerSocket
{
}

#if defined(OL_NO_OPENSTEP)
+ (id) initialize;
#else
+ (void) initialize;
#endif

+ (id) socket;

+ (id) socketWithLocalInternetAddress: (OLInternetAddress*)address;

+ (id) socketWithLocalInternetAddress: (OLInternetAddress*)address queueLength: (unsigned)qLen;

+ (id) socketWithQueueLength: (unsigned)qLen;

@end

@interface OLInternetClientSocket : OLClientSocket
{
}

#if defined(OL_NO_OPENSTEP)
+ (id) initialize;
#else
+ (void) initialize;
#endif

+ (id) socket;

+ (id) socketWithRemoteInternetAddress: (OLInternetAddress*)remote;

+ (id) socketWithRemoteInternetAddress: (OLInternetAddress*)remote localAddress: (OLInternetAddress*)local;

@end

#if defined(OL_HAVE_UNIX_SOCKETS)

@interface OLUnixServerSocket : OLServerSocket
{
@protected
    OLUnixAddress* localAddress;
}

+ (id) socket;

+ (id) socketWithLocalUnixAddress: (OLUnixAddress*)address;

+ (id) socketWithLocalUnixAddress: (OLUnixAddress*)address queueLength: (unsigned)qLen;

+ (id) socketWithQueueLength: (unsigned)qLen;

- (void) bindToAddress: (OLSocketAddress*)address;
- (void) close;
- (OLSocketAddress*) localAddress;

@end

@interface OLUnixClientSocket : OLClientSocket
{
}

+ (id) socket;

+ (id) socketWithRemoteUnixAddress: (OLUnixAddress*)remote;

+ (id) socketWithRemoteUnixAddress: (OLUnixAddress*)remote localAddress: (OLUnixAddress*)local;

- (void) bindToAddress: (OLSocketAddress*)address;

@end

#endif

#endif

---

Generated Sun Apr 22 15:12:39 2007, © 2004-2007 Will Mason