| 1 |
(* ClientSocket.def provides a client TCP interface for ChanIds. |
| 2 |
|
| 3 |
Copyright (C) 2008-2025 Free Software Foundation, Inc. |
| 4 |
Contributed by Gaius Mulley <[email protected]>. |
| 5 |
|
| 6 |
This file is part of GNU Modula-2. |
| 7 |
|
| 8 |
GNU Modula-2 is free software; you can redistribute it and/or modify |
| 9 |
it under the terms of the GNU General Public License as published by |
| 10 |
the Free Software Foundation; either version 3, or (at your option) |
| 11 |
any later version. |
| 12 |
|
| 13 |
GNU Modula-2 is distributed in the hope that it will be useful, but |
| 14 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 16 |
General Public License for more details. |
| 17 |
|
| 18 |
Under Section 7 of GPL version 3, you are granted additional |
| 19 |
permissions described in the GCC Runtime Library Exception, version |
| 20 |
3.1, as published by the Free Software Foundation. |
| 21 |
|
| 22 |
You should have received a copy of the GNU General Public License and |
| 23 |
a copy of the GCC Runtime Library Exception along with this program; |
| 24 |
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
| 25 |
<http://www.gnu.org/licenses/>. *) |
| 26 |
|
| 27 |
DEFINITION MODULE ClientSocket ; |
| 28 |
|
| 29 |
FROM IOChan IMPORT ChanId ; |
| 30 |
FROM ChanConsts IMPORT FlagSet, OpenResults ; |
| 31 |
|
| 32 |
|
| 33 |
(* |
| 34 |
OpenSocket - opens a TCP client connection to host:port. |
| 35 |
*) |
| 36 |
|
| 37 |
PROCEDURE OpenSocket (VAR cid: ChanId; |
| 38 |
host: ARRAY OF CHAR; port: CARDINAL; |
| 39 |
f: FlagSet; VAR res: OpenResults) ; |
| 40 |
|
| 41 |
(* |
| 42 |
Close - if the channel identified by cid is not open to |
| 43 |
a socket stream, the exception wrongDevice is |
| 44 |
raised; otherwise closes the channel, and assigns |
| 45 |
the value identifying the invalid channel to cid. |
| 46 |
*) |
| 47 |
|
| 48 |
PROCEDURE Close (VAR cid: ChanId) ; |
| 49 |
|
| 50 |
|
| 51 |
(* |
| 52 |
IsSocket - tests if the channel identified by cid is open as |
| 53 |
a client socket stream. |
| 54 |
*) |
| 55 |
|
| 56 |
PROCEDURE IsSocket (cid: ChanId) : BOOLEAN ; |
| 57 |
|
| 58 |
|
| 59 |
END ClientSocket. |