swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax     Other Library Functions  
function  

tcp.port

 
 

Library: TCP/IP client and server support (OMTCP)
Import: omtcp.xmd
Return type: Integer

Returns:


Declaration

define external integer function tcp.port
   of value tcp.service Service

Argument definitions

Service
is an existing tcp.service object.


Purpose

Use tcp.port to learn which port number the TCP service object listens on for incoming connections.

Requirements

Service must represent an existing service (else external exception TCP05).

Usage Notes

This API is particularly useful when you call tcp.create-service without specifying a port.

Example


  import "omtcp.xmd" prefixed by tcp.
  
  process
     local tcp.service Demo
     local integer Port
  
     set Demo to tcp.create-service
     set Port to tcp.port of Demo
     output "The selected service port for Demo is %d(Port)%n"

    Related Syntax
   tcp.service
   tcp.accept-connection
   tcp.destroy-service
   tcp.create-service
 
  Other Library Functions
   tcp.accept-connection
   tcp.connect
   tcp.connection
   tcp.create-service
   tcp.destroy-service
   tcp.disconnect
   tcp.end-delimited
   tcp.get-string
   tcp.is-connected
   tcp.multi-packet
   tcp.omtcp-version
   tcp.peer-ip
   tcp.peer-name
   tcp.port
   tcp.put-string
   tcp.reader
   tcp.service
   tcp.set-buffering
   tcp.single-packet
   tcp.terminate-reader
   tcp.wait-for-input
   tcp.writer
 
 

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

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.