/* Interface for abstract superclass port for use with Connection
   Copyright (C) 1994, 1995, 1996 Free Software Foundation, Inc.
   
   Written by:  R. Andrew McCallum <mccallum@gnu.ai.mit.edu>
   Created: July 1994
   
   This file is part of the GNU Objective C Class Library.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.
   
   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   */ 

#ifndef __Port_h_OBJECTS_INCLUDE
#define __Port_h_OBJECTS_INCLUDE

#include <objects/stdobjects.h>
#include <objects/Coding.h>
#include <objects/MemoryStream.h>
#include <objects/NSString.h>

/* xxx Use something like this? */
@protocol PacketSending
@end

@interface Port : NSObject
{
  unsigned is_valid:1;
  unsigned tcp_port_filler:7;
  unsigned retain_count:24;
}
- (void) invalidate;
- (BOOL) isValid;
- (void) close;

- (Class) packetClass;

@end


@interface InPort : Port

+ newForReceiving;
+ newForReceivingFromRegisteredName: (id <String>)name;

/* Get a packet from the net and return it.  If no packet is received 
   within MILLISECONDS, then return nil.  The caller is responsible 
   for releasing the packet. */
- receivePacketWithTimeout: (int)milliseconds;

@end


@interface OutPort : Port

+ newForSendingToRegisteredName: (id <String>)name 
                         onHost: (id <String>)hostname;
- (BOOL) sendPacket: packet withTimeout: (int)milliseconds;

@end

extern NSString *PortBecameInvalidNotification;

@interface Packet : MemoryStream
{
  id reply_port;
}

- initForSendingWithCapacity: (unsigned)c
   replyPort: p;
- replyPort;

@end

#endif /* __Port_h_OBJECTS_INCLUDE */