← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Foundation/include/Poco/OpcomChannel.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Foundation/include/Poco/OpcomChannel.h
 
1
//
 
2
// OpcomChannel.h
 
3
//
 
4
// $Id: //poco/1.2/Foundation/include/Poco/OpcomChannel.h#1 $
 
5
//
 
6
// Library: Foundation
 
7
// Package: Logging
 
8
// Module:  OpcomChannel
 
9
//
 
10
// Definition of the OpcomChannel class specific to OpenVMS.
 
11
//
 
12
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 
13
// and Contributors.
 
14
//
 
15
// Permission is hereby granted, free of charge, to any person or organization
 
16
// obtaining a copy of the software and accompanying documentation covered by
 
17
// this license (the "Software") to use, reproduce, display, distribute,
 
18
// execute, and transmit the Software, and to prepare derivative works of the
 
19
// Software, and to permit third-parties to whom the Software is furnished to
 
20
// do so, all subject to the following:
 
21
// 
 
22
// The copyright notices in the Software and this entire statement, including
 
23
// the above license grant, this restriction and the following disclaimer,
 
24
// must be included in all copies of the Software, in whole or in part, and
 
25
// all derivative works of the Software, unless such copies or derivative
 
26
// works are solely in the form of machine-executable object code generated by
 
27
// a source language processor.
 
28
// 
 
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
35
// DEALINGS IN THE SOFTWARE.
 
36
//
 
37
 
 
38
 
 
39
#ifndef Foundation_OpcomChannel_INCLUDED
 
40
#define Foundation_OpcomChannel_INCLUDED
 
41
 
 
42
 
 
43
#include "Poco/Foundation.h"
 
44
#include "Poco/Channel.h"
 
45
 
 
46
 
 
47
namespace Poco {
 
48
 
 
49
 
 
50
class Foundation_API OpcomChannel: public Channel
 
51
        /// A OpenVMS-only channel that uses the OpenVMS OPCOM service.
 
52
{
 
53
public:
 
54
        OpcomChannel();
 
55
                /// Creates an OpcomChannel that uses the OPC$M_NM_CENTRL
 
56
                /// target.
 
57
                
 
58
        OpcomChannel(int target);
 
59
                /// Creates an OpcomChannel that uses the given target.
 
60
                /// Specify one of the OPC$M_NM_* values.
 
61
                /// See also setProperty().
 
62
                
 
63
        void log(const Message& msg);
 
64
                /// Logs the given message using the OpenVMS OPCOM service.
 
65
                
 
66
        void setProperty(const std::string& name, const std::string& value);
 
67
                /// Sets the property with the given name. 
 
68
                /// 
 
69
                /// The only supported property is "target", which must
 
70
                /// be set to one of the following values:
 
71
                ///
 
72
                ///   * CARDS:    Card device operator
 
73
                ///   * CENTRL:   Central operator
 
74
                ///   * SECURITY: Security operator
 
75
                ///   * CLUSTER:  OpenVMS Cluster operator
 
76
                ///   * DEVICE:   Device status information
 
77
                ///   * DISKS:    Disks operator
 
78
                ///   * NTWORK:   Network operator
 
79
                ///   * TAPES:    Tapes operator
 
80
                ///   * PRINT:    Printer operator
 
81
                ///   * OPER1 .. 
 
82
                ///   * OPER12:   System-manager-defined operator functions
 
83
 
 
84
        std::string getProperty(const std::string& name) const;
 
85
                /// Returns the value of the property with the given name.
 
86
                /// See setProperty() for a description of the supported
 
87
                /// properties.
 
88
 
 
89
        static const std::string PROP_TARGET;
 
90
                
 
91
protected:
 
92
        ~OpcomChannel();
 
93
        
 
94
private:
 
95
        int _target;
 
96
};
 
97
 
 
98
 
 
99
} // namespace Poco
 
100
 
 
101
 
 
102
#endif // Foundation_OpcomChannel_INCLUDED