swirl Guide to OmniMark 5   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesOMX VariablesErrors
 
    Related Concepts   Other Library Functions  
function   TCPServiceClose    

Library: omtcp - TCP/IP client and server support
Include: omtcp.xin

Declaration

  define external function TCPServiceClose
     value TCPService this-TCPService


Purpose

This function closes a TCP service object, effectively detaching the program from the TCP port. Once closed, no more client connection requests can be accepted.

It is valid to use TCPServiceClose on a TCP service object that is already closed or that was never opened. In both cases, TCPServiceClose simply does nothing.

Note that allowing an OmniMark TCP service variable to go out of scope (exiting a local scope for a local variable, or exiting the OmniMark program for a global variable) has the effect of doing a TCPClose on the variable. As long as TCP service variables are declared at a scope level that corresponds to the lifetime of the service (which is good programming practice) there is never any need to use TCPClose.

Argument:

Example

  TCPServiceClose omdemo-service

      Related Concepts
   Security considerations
 
Other Library Functions
   TCPConnectionClose
   TCPConnectionGetCharacters
   TCPConnectionGetLine
   TCPConnectionGetOutput
   TCPConnectionGetPeerIP
   TCPConnectionGetPeerName
   TCPConnectionGetSource
   TCPConnectionGetStatusReport
   TCPConnectionHasCharactersToRead
   TCPConnectionIsConnected
   TCPConnectionIsInError
   TCPConnectionOpen
   TCPConnectionPut
   TCPConnectionSetBuffering
   TCPConnectionSignalSourceEnd
   TCPIsVersionCompatible
   TCPLibraryVersion
   TCPServiceAcceptConnection
   TCPServiceClose
   TCPServiceGetPort
   TCPServiceGetStatusReport
   TCPServiceIsInError
   TCPServiceIsOpen
   TCPServiceOpen
   TCPTraceConnectionOpen
 
----  

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ OMX ] [ OMX ] [ ERRORS ]

Generated: August 11, 2000 at 3:08:04 pm
If you have any comments about this section of the documentation, send email to docerrors@omnimark.com

Copyright © OmniMark Technologies Corporation, 1988-2000.