File: Poco.OpcomChannel.html

package info (click to toggle)
poco-doc 1.3.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,096 kB
  • sloc: makefile: 9
file content (96 lines) | stat: -rw-r--r-- 6,879 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::OpcomChannel</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class OpcomChannel</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Logging<br />
<b>Header:</b> Poco/OpcomChannel.h</p>
<h2>Description</h2>
<div class="description">
<p>A OpenVMS-only channel that uses the OpenVMS OPCOM service. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Channel</a></p>
<p><b>All Base Classes: </b><a href="Poco.Channel.html" title="class Poco::Channel">Channel</a>, <a href="Poco.Configurable.html" title="class Poco::Configurable">Configurable</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">RefCountedObject</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.OpcomChannel.html#9153" title="Poco::OpcomChannel::getProperty()">getProperty</a>, <a href="Poco.OpcomChannel.html#9148" title="Poco::OpcomChannel::log()">log</a>, <a href="Poco.OpcomChannel.html#9150" title="Poco::OpcomChannel::setProperty()">setProperty</a></p>
<p><b>Inherited Functions: </b><a href="Poco.Channel.html#4145" title="Poco::Channel::close()">close</a>, <a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Channel.html#4151" title="Poco::Channel::getProperty()">getProperty</a>, <a href="Poco.Channel.html#4146" title="Poco::Channel::log()">log</a>, <a href="Poco.Channel.html#4144" title="Poco::Channel::open()">open</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Channel.html#4148" title="Poco::Channel::setProperty()">setProperty</a></p>
<h2>Constructors</h2>
<h3><a name="9145">OpcomChannel</a></h3>
<p class="decl"><a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a>();</p>
<div class="description">
<p>Creates an <a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a> that uses the OPC$M_NM_CENTRL target. </p>
</div>
<h3><a name="9146">OpcomChannel</a></h3>
<p class="decl"><a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;int target<br />);</p>
<div class="description">
<p>Creates an <a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a> that uses the given target. Specify one of the OPC$M_NM_* values. See also <a href="Poco.OpcomChannel.html#9150" title="Poco::OpcomChannel::setProperty()">setProperty</a>(). </p>
</div>
<h2>Destructor</h2>
<h3><a name="9156">~OpcomChannel</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.OpcomChannel.html" title="class Poco::OpcomChannel">OpcomChannel</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="9153">getProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::string getProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />) const;</p>
<div class="description">
<p>Returns the value of the property with the given name. See <a href="Poco.OpcomChannel.html#9150" title="Poco::OpcomChannel::setProperty()">setProperty</a>() for a description of the supported properties. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4151" title="Poco::Channel::getProperty()">Poco::Channel::getProperty()</a></p></div>
<h3><a name="9148">log</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void log(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Message.html" title="class Poco::Message">Message</a> &amp; msg<br />);</p>
<div class="description">
<p>Logs the given message using the OpenVMS OPCOM service. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4146" title="Poco::Channel::log()">Poco::Channel::log()</a></p></div>
<h3><a name="9150">setProperty</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setProperty(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; value<br />);</p>
<div class="description">
<p>Sets the property with the given name.  </p>
<p>The only supported property is &quot;target&quot;, which must be set to one of the following values: </p>
<p></p>
<ul>
<li>CARDS:    Card device operator </li>
<li>CENTRL:   Central operator </li>
<li>SECURITY: Security operator </li>
<li>CLUSTER:  OpenVMS Cluster operator </li>
<li>DEVICE:   Device status information </li>
<li>DISKS:    Disks operator </li>
<li>NTWORK:   Network operator </li>
<li>TAPES:    Tapes operator </li>
<li>PRINT:    Printer operator </li>
<li>OPER1 ..  </li>
<li>OPER12:   System-manager-defined operator functions </li>
</ul>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Channel.html#4148" title="Poco::Channel::setProperty()">Poco::Channel::setProperty()</a></p></div>
<h2>Variables</h2>
<h3><a name="9155">PROP_TARGET</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const std::string <a href="Poco.OpcomChannel.html#9155" title="Poco::OpcomChannel::PROP_TARGET">PROP_TARGET</a>;</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>