1cosFileTransferApp(3)      Erlang Module Definition      cosFileTransferApp(3)
2
3
4

NAME

6       cosFileTransferApp  -  The  main module of the cosFileTransfer applica‐
7       tion.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosFileTransfer/include/*.hrl").
12
13       This module contains the functions for starting and stopping the appli‐
14       cation.
15

EXPORTS

17       install() -> Return
18
19              Types:
20
21                 Return = ok | {'EXIT', Reason}
22
23              This  operation  installs the cosFileTransfer application. Note,
24              the cosProperty application must be installed prior to  invoking
25              this operation.
26
27       uninstall() -> Return
28
29              Types:
30
31                 Return = ok | {'EXIT', Reason}
32
33              This operation uninstalls the cosFileTransfer application.
34
35       start() -> Return
36
37              Types:
38
39                 Return = ok | {error, Reason}
40
41              This operation starts the cosFileTransfer application.
42
43       stop() -> Return
44
45              Types:
46
47                 Return = ok | {error, Reason}
48
49              This operation stops the cosFileTransfer application.
50
51       create_VFS(Type, Content, Host, Port [,Options]) -> Return
52
53              Types:
54
55                 Type  =  'FTP'  |  {'NATIVE', 'cosFileTransferNATIVE_file'} |
56                 {'NATIVE', MyModule}
57                 Content = []
58                 Host = string(), e.g. "myHost@myServer" or "012.345.678.910"
59                 Port = integer()
60                 Options = [Option]
61                 Option = {protocol, Protocol} | {connect_timeout, Seconds}
62                 Protocol = tcp | ssl
63                 Return = VFS | {'EXCEPTION, E}
64                 VFS = #objref
65
66              This operation creates a new instance of a Virtual File  System.
67              The Type parameter determines which type we want the VFS to rep‐
68              resent. 'FTP' maps to the INETS ftp implementation, while  {'NA‐
69              TIVE', 'cosFileTransferNATIVE_file'} uses the file module. It is
70              also possible to implement own mappings which are  activated  by
71              supplying  {'NATIVE', MyModule}. The MyModule module must export
72              the same functions and behave in the same way as the  INETS  ftp
73              module, and an operation named open(Host, Port), which shall re‐
74              turn {ok, Pid} or {error, Reason}.
75
76              If no Options are supplied the default  setting  will  be  used,
77              i.e., tcp and 60 seconds.
78
79              The  Content  parameter is currently ignored by must be supplied
80              as an empty list.
81
82       ssl_server_certfile() -> string()
83
84              This function returns a path to a file containing a chain of PEM
85              encoded  certificates for the cosFileTransfer as target. This is
86              configured by setting the application variable  ssl_server_cert‐
87              file.
88
89       ssl_client_certfile() -> string()
90
91              This function returns a path to a file containing a chain of PEM
92              encoded certificates used in outgoing calls. The  default  value
93              is    configured    by    setting   the   application   variable
94              ssl_client_certfile.
95
96       ssl_server_verify() -> 0 | 1 | 2
97
98              This function returns the type of verification used by SSL  dur‐
99              ing  authentication  of the other peer for incoming calls. It is
100              configured by setting the application  variable  ssl_server_ver‐
101              ify.
102
103       ssl_client_verify() -> 0 | 1 | 2
104
105              This  function returns the type of verification used by SSL dur‐
106              ing authentication of the other peer for outgoing calls. The de‐
107              fault  value  is  configured by setting the application variable
108              ssl_client_verify.
109
110       ssl_server_depth() -> int()
111
112              This function returns the SSL verification  depth  for  incoming
113              calls.  It  is  configured  by  setting the application variable
114              ssl_server_depth.
115
116       ssl_client_depth() -> int()
117
118              This function returns the SSL verification  depth  for  outgoing
119              calls.  The  default value is configured by setting the applica‐
120              tion variable ssl_client_depth.
121
122
123
124Ericsson AB                  cosFileTransfer 5.0.1       cosFileTransferApp(3)