mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-26 18:21:04 +00:00
8a6b87d429
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@1124 72102866-910b-0410-8b05-ffd578937521
125 lines
3.3 KiB
Objective-C
125 lines
3.3 KiB
Objective-C
/* 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) outPacketClass;
|
||
- (Class) outPacketClass;
|
||
|
||
@end
|
||
|
||
|
||
@interface InPort : Port
|
||
{
|
||
id _packet_invocation;
|
||
}
|
||
|
||
+ newForReceiving;
|
||
+ newForReceivingFromRegisteredName: (id <String>)name;
|
||
|
||
/* Register/Unregister this port for input handling through RunLoop
|
||
RUN_LOOP in mode MODE. */
|
||
- (void) addToRunLoop: run_loop forMode: (id <String>)mode;
|
||
- (void) removeFromRunLoop: run_loop forMode: (id <String>)mode;
|
||
|
||
/* When a RunLoop is handling this InPort, and a new incoming
|
||
packet arrives, INVOCATION will be invoked with the new packet
|
||
as an argument. The INVOCATION is responsible for releasing
|
||
the packet. */
|
||
- (void) setReceivedPacketInvocation: (id <Invoking>)invocation;
|
||
|
||
/* An alternative to the above way for receiving packets from this port.
|
||
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;
|
||
|
||
@end
|
||
|
||
extern NSString *PortBecameInvalidNotification;
|
||
|
||
|
||
|
||
/* Objects for holding incoming/outgoing data to/from ports. */
|
||
|
||
@interface InPacket : MemoryStream
|
||
{
|
||
id _receiving_in_port;
|
||
id _reply_out_port;
|
||
}
|
||
|
||
- replyOutPort;
|
||
- receivingInPort;
|
||
|
||
/* Do not call this method yourself; it is to be called by subclassers.
|
||
InPackets are created for you by the InPort object, and are
|
||
made available as the argument to the received packet invocation. */
|
||
- initForReceivingWithCapacity: (unsigned)s
|
||
receivingInPort: ip
|
||
replyOutPort: op;
|
||
|
||
@end
|
||
|
||
@interface OutPacket : MemoryStream
|
||
{
|
||
id _reply_in_port;
|
||
}
|
||
|
||
- initForSendingWithCapacity: (unsigned)c
|
||
replyInPort: p;
|
||
- replyInPort;
|
||
|
||
+ (unsigned) prefixSize;
|
||
|
||
@end
|
||
|
||
#endif /* __Port_h_OBJECTS_INCLUDE */
|