tcp.put-string

function

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

Declaration

define external function tcp.put-string
  to      value tcp.connection Connection
  from    value string         characters
  timeout value integer        ms 	    optional

Argument definitions

Connection: is a tcp.connection object representing an existing connection.

characters: are the characters that will be put in the output stream.

ms: is how long the function will wait for at least one character to be written, expressed in milliseconds.

Purpose

Use tcp.put-string to write characters to a TCP connection (sending them to the receiver).

Requirements

Connection must exist (else external exception TCP05).

There may not be an active external sink derived from Connection with tcp.writer (else external exception TCP20).

Usage Notes

If an error occurs while writing, external exception TCP12 is thrown.

If the write operation times out, external exception TCP06 is thrown.

Sequential uses of tcp.put-string is allowed.

Example

  import "omtcp.xmd" prefixed by tcp.
  process
     local tcp.connection Connection-1
  
     set Connection-1 to tcp.connect to "localhost" on 5300
  
     tcp.put-string to Connection-1 from "hello world"
     tcp.put-string to Connection-1 from ((("*" ||* 78) || "%n") ||* 40)

Related Topics

Other Library Functions