← Back to branch summary

~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/cosFileTransfer/doc/src/cosFileTransferApp.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (3.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090215164252-q5x4rcf8a5pbesb1
Tags: 1:12.b.5-dfsg-2
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/cosFileTransfer/doc/src/cosFileTransferApp.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2000</year>
 
8
      <year>2008</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>cosFileTransferApp</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <checked></checked>
 
30
    <date>2000-08-24</date>
 
31
    <rev>PA1</rev>
 
32
  </header>
 
33
  <module>cosFileTransferApp</module>
 
34
  <modulesummary>The main module of the cosFileTransfer application.</modulesummary>
 
35
  <description>
 
36
    <p>To get access to the record definitions for the structures use:      <br></br>
 
37
<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p>
 
38
    <p>This module contains the functions for starting and stopping the application.</p>
 
39
  </description>
 
40
  <funcs>
 
41
    <func>
 
42
      <name>install() -> Return</name>
 
43
      <fsummary>Install the cosFileTransfer application</fsummary>
 
44
      <type>
 
45
        <v>Return = ok | {'EXIT', Reason}</v>
 
46
      </type>
 
47
      <desc>
 
48
        <p>This operation installs the cosFileTransfer application. Note, the
 
49
          <c>cosProperty</c> application must be installed prior to invoking this
 
50
          operation.</p>
 
51
      </desc>
 
52
    </func>
 
53
    <func>
 
54
      <name>uninstall() -> Return</name>
 
55
      <fsummary>Uninstall the cosFileTransfer application</fsummary>
 
56
      <type>
 
57
        <v>Return = ok | {'EXIT', Reason}</v>
 
58
      </type>
 
59
      <desc>
 
60
        <p>This operation uninstalls the cosFileTransfer application.</p>
 
61
      </desc>
 
62
    </func>
 
63
    <func>
 
64
      <name>start() -> Return</name>
 
65
      <fsummary>Start the cosFileTransfer application</fsummary>
 
66
      <type>
 
67
        <v>Return = ok | {error, Reason}</v>
 
68
      </type>
 
69
      <desc>
 
70
        <p>This operation starts the cosFileTransfer application.</p>
 
71
      </desc>
 
72
    </func>
 
73
    <func>
 
74
      <name>stop() -> Return</name>
 
75
      <fsummary>Stop the cosFileTransfer application</fsummary>
 
76
      <type>
 
77
        <v>Return = ok | {error, Reason}</v>
 
78
      </type>
 
79
      <desc>
 
80
        <p>This operation stops the cosFileTransfer application.</p>
 
81
      </desc>
 
82
    </func>
 
83
    <func>
 
84
      <name>create_VFS(Type, Content, Host, Port [,Options]) -> Return</name>
 
85
      <fsummary>Create a new instance of a Virtual File System</fsummary>
 
86
      <type>
 
87
        <v>Type = 'FTP' | {'NATIVE', 'cosFileTransferNATIVE_file'} |  {'NATIVE', MyModule}</v>
 
88
        <v>Content = []</v>
 
89
        <v>Host = string(), e.g. "myHost@myServer" or "012.345.678.910"</v>
 
90
        <v>Port = integer()</v>
 
91
        <v>Options = [Option]</v>
 
92
        <v>Option = {protocol, Protocol} | {connect_timeout, Seconds}</v>
 
93
        <v>Protocol = tcp | ssl</v>
 
94
        <v>Return = VFS | {'EXCEPTION, E}</v>
 
95
        <v>VFS = #objref</v>
 
96
      </type>
 
97
      <desc>
 
98
        <p>This operation creates a new instance of a Virtual File System. The 
 
99
          <c>Type</c> parameter determines which type we want the VFS to represent.
 
100
          'FTP' maps to the <c>INETS</c> ftp implementation, while
 
101
          {'NATIVE', 'cosFileTransferNATIVE_file'} uses the <c>file</c> module.
 
102
          It is also possible to implement own mappings which are activated by
 
103
          supplying {'NATIVE', MyModule}. The MyModule module must export the same
 
104
          functions and behave in the same way as the INETS ftp module, and
 
105
          an operation named <c>open(Host, Port)</c>, which shall return 
 
106
          <c>{ok, Pid}</c> or <c>{error, Reason}</c>.</p>
 
107
        <p>If no <c>Options</c> are supplied the default setting will be
 
108
          used, i.e., tcp and 60 seconds.</p>
 
109
        <p>The <c>Content</c> parameter is currently ignored by must be supplied
 
110
          as an empty list.</p>
 
111
      </desc>
 
112
    </func>
 
113
    <func>
 
114
      <name>ssl_server_certfile() -> string()</name>
 
115
      <fsummary>Display  the path to the target certificate</fsummary>
 
116
      <desc>
 
117
        <p>This function returns a path to a file containing a chain of PEM encoded 
 
118
          certificates for the cosFileTransfer as target. 
 
119
          This is configured by setting the application variable 
 
120
          <em>ssl_server_certfile</em>.</p>
 
121
      </desc>
 
122
    </func>
 
123
    <func>
 
124
      <name>ssl_client_certfile() -> string()</name>
 
125
      <fsummary>Display the path to the client certificate</fsummary>
 
126
      <desc>
 
127
        <p>This function returns a path to a file containing a chain of PEM encoded 
 
128
          certificates used in outgoing calls.
 
129
          The default value is configured by setting the application variable 
 
130
          <em>ssl_client_certfile</em>.</p>
 
131
      </desc>
 
132
    </func>
 
133
    <func>
 
134
      <name>ssl_server_verify() -> 0 | 1 | 2</name>
 
135
      <fsummary>Display the SSL verification type for incoming calls</fsummary>
 
136
      <desc>
 
137
        <p>This function returns the type of verification used by SSL during authentication of the other 
 
138
          peer for incoming calls. 
 
139
          It is configured by setting the application variable 
 
140
          <em>ssl_server_verify</em>.</p>
 
141
      </desc>
 
142
    </func>
 
143
    <func>
 
144
      <name>ssl_client_verify() -> 0 | 1 | 2</name>
 
145
      <fsummary>Display the SSL verification type for outgoing calls</fsummary>
 
146
      <desc>
 
147
        <p>This function returns  the type of verification used by SSL during authentication of the other 
 
148
          peer for outgoing calls. 
 
149
          The default value is configured by setting the application variable 
 
150
          <em>ssl_client_verify</em>.</p>
 
151
      </desc>
 
152
    </func>
 
153
    <func>
 
154
      <name>ssl_server_depth() -> int()</name>
 
155
      <fsummary>Display the SSL verification depth for incoming calls</fsummary>
 
156
      <desc>
 
157
        <p>This function returns the SSL verification depth for incoming calls. 
 
158
          It is configured by setting the application variable 
 
159
          <em>ssl_server_depth</em>.</p>
 
160
      </desc>
 
161
    </func>
 
162
    <func>
 
163
      <name>ssl_client_depth() ->  int()</name>
 
164
      <fsummary>Display the SSL verification depth for outgoing calls</fsummary>
 
165
      <desc>
 
166
        <p>This function returns the SSL verification depth for outgoing calls. 
 
167
          The default value is configured by setting the application variable 
 
168
          <em>ssl_client_depth</em>.</p>
 
169
      </desc>
 
170
    </func>
 
171
  </funcs>
 
172
  
 
173
</erlref>
 
174