From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/cosFileTransfer/doc/src/cosFileTransferApp.xml | 172 +++++++++++++++++++++ 1 file changed, 172 insertions(+) create mode 100644 lib/cosFileTransfer/doc/src/cosFileTransferApp.xml (limited to 'lib/cosFileTransfer/doc/src/cosFileTransferApp.xml') diff --git a/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml b/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml new file mode 100644 index 0000000000..e27bffd44d --- /dev/null +++ b/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml @@ -0,0 +1,172 @@ + + + + +
+ + 20002009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + cosFileTransferApp + + + + 2000-08-24 + PA1 +
+ cosFileTransferApp + The main module of the cosFileTransfer application. + +

To get access to the record definitions for the structures use:

+-include_lib("cosFileTransfer/include/*.hrl").

+

This module contains the functions for starting and stopping the application.

+ + + + install() -> Return + Install the cosFileTransfer application + + Return = ok | {'EXIT', Reason} + + +

This operation installs the cosFileTransfer application. Note, the + cosProperty application must be installed prior to invoking this + operation.

+ + + + uninstall() -> Return + Uninstall the cosFileTransfer application + + Return = ok | {'EXIT', Reason} + + +

This operation uninstalls the cosFileTransfer application.

+ + + + start() -> Return + Start the cosFileTransfer application + + Return = ok | {error, Reason} + + +

This operation starts the cosFileTransfer application.

+ + + + stop() -> Return + Stop the cosFileTransfer application + + Return = ok | {error, Reason} + + +

This operation stops the cosFileTransfer application.

+ + + + create_VFS(Type, Content, Host, Port [,Options]) -> Return + Create a new instance of a Virtual File System + + Type = 'FTP' | {'NATIVE', 'cosFileTransferNATIVE_file'} | {'NATIVE', MyModule} + Content = [] + Host = string(), e.g. "myHost@myServer" or "012.345.678.910" + Port = integer() + Options = [Option] + Option = {protocol, Protocol} | {connect_timeout, Seconds} + Protocol = tcp | ssl + Return = VFS | {'EXCEPTION, E} + VFS = #objref + + +

This operation creates a new instance of a Virtual File System. The + Type parameter determines which type we want the VFS to represent. + 'FTP' maps to the INETS ftp implementation, while + {'NATIVE', 'cosFileTransferNATIVE_file'} uses the file module. + It is also possible to implement own mappings which are activated by + supplying {'NATIVE', MyModule}. The MyModule module must export the same + functions and behave in the same way as the INETS ftp module, and + an operation named open(Host, Port), which shall return + {ok, Pid} or {error, Reason}.

+

If no Options are supplied the default setting will be + used, i.e., tcp and 60 seconds.

+

The Content parameter is currently ignored by must be supplied + as an empty list.

+ + + + ssl_server_certfile() -> string() + Display the path to the target certificate + +

This function returns a path to a file containing a chain of PEM encoded + certificates for the cosFileTransfer as target. + This is configured by setting the application variable + ssl_server_certfile.

+ + + + ssl_client_certfile() -> string() + Display the path to the client certificate + +

This function returns a path to a file containing a chain of PEM encoded + certificates used in outgoing calls. + The default value is configured by setting the application variable + ssl_client_certfile.

+ + + + ssl_server_verify() -> 0 | 1 | 2 + Display the SSL verification type for incoming calls + +

This function returns the type of verification used by SSL during authentication of the other + peer for incoming calls. + It is configured by setting the application variable + ssl_server_verify.

+ + + + ssl_client_verify() -> 0 | 1 | 2 + Display the SSL verification type for outgoing calls + +

This function returns the type of verification used by SSL during authentication of the other + peer for outgoing calls. + The default value is configured by setting the application variable + ssl_client_verify.

+ + + + ssl_server_depth() -> int() + Display the SSL verification depth for incoming calls + +

This function returns the SSL verification depth for incoming calls. + It is configured by setting the application variable + ssl_server_depth.

+ + + + ssl_client_depth() -> int() + Display the SSL verification depth for outgoing calls + +

This function returns the SSL verification depth for outgoing calls. + The default value is configured by setting the application variable + ssl_client_depth.

+ + + + + + -- cgit v1.2.3