File: cosFileTransferApp.html

package info (click to toggle)
erlang-doc-html 1%3A10.b.1a-1
links: PTS
area: main
in suites: sarge
size: 22,488 kB
ctags: 9,933
sloc: erlang: 505; ansic: 323; perl: 61; sh: 45; makefile: 39
file content (228 lines) | stat: -rw-r--r-- 6,545 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>cosFileTransferApp</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>cosFileTransferApp</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
cosFileTransferApp
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
The main module of the cosFileTransfer application.
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P> To get access to the record definitions for the structures use:<BR>

<CODE>-include_lib(&#34;cosFileTransfer/include/*.hrl&#34;).</CODE>

<P> This module contains the functions for starting and stopping the application.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="install/0"><STRONG><CODE>install() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation installs the cosFileTransfer application. Note, the
<CODE>cosProperty</CODE> application must be installed prior to invoking this
operation.

</DIV>

<P><A NAME="uninstall/0"><STRONG><CODE>uninstall() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation uninstalls the cosFileTransfer application.

</DIV>

<P><A NAME="start/0"><STRONG><CODE>start() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation starts the cosFileTransfer application.

</DIV>

<P><A NAME="stop/0"><STRONG><CODE>stop() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation stops the cosFileTransfer application.

</DIV>

<P><A NAME="create_VFS/5"><STRONG><CODE>create_VFS(Type, Content, Host, Port [,Options]) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Type = 'FTP' | {'NATIVE', 'cosFileTransferNATIVE_file'} | 
{'NATIVE', MyModule}</CODE></STRONG><BR>
<STRONG><CODE>Content = []</CODE></STRONG><BR>
<STRONG><CODE>Host = string(), e.g. &#34;myHost@myServer&#34; or &#34;012.345.678.910&#34;</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {protocol, Protocol} | {connect_timeout, Seconds}</CODE></STRONG><BR>
<STRONG><CODE>Protocol = tcp | ssl</CODE></STRONG><BR>
<STRONG><CODE>Return = VFS | {'EXCEPTION, E}</CODE></STRONG><BR>
<STRONG><CODE>VFS = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a new instance of a Virtual File System. The 
<CODE>Type</CODE> parameter determines which type we want the VFS to represent.
'FTP' maps to the <CODE>INTES</CODE> ftp implementation, while
{'NATIVE', 'cosFileTransferNATIVE_file'} uses the <CODE>file</CODE> 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.

<P>If no <CODE>Options</CODE> are supplied the default setting will be
used, i.e., tcp and 60 seconds.

<P>The <CODE>Content</CODE> parameter is currently ignored by must be supplied
as an empty list.

</DIV>

<P><A NAME="ssl_server_certfile/0"><STRONG><CODE>ssl_server_certfile() -&#62; string()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      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 
         <STRONG>ssl_server_certfile</STRONG>.
        
</DIV>

<P><A NAME="ssl_client_certfile/0"><STRONG><CODE>ssl_client_certfile() -&#62; string()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      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 
         <STRONG>ssl_client_certfile</STRONG>.
        
</DIV>

<P><A NAME="ssl_server_verify/0"><STRONG><CODE>ssl_server_verify() -&#62; 0 | 1 | 2</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      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 
         <STRONG>ssl_server_verify</STRONG>.
        
</DIV>

<P><A NAME="ssl_client_verify/0"><STRONG><CODE>ssl_client_verify() -&#62; 0 | 1 | 2</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      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 
         <STRONG>ssl_client_verify</STRONG>.
        
</DIV>

<P><A NAME="ssl_server_depth/0"><STRONG><CODE>ssl_server_depth() -&#62; int()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      This function returns the SSL verification depth for incoming calls. 
         It is configured by setting the application variable 
         <STRONG>ssl_server_depth</STRONG>.
        
</DIV>

<P><A NAME="ssl_client_depth/0"><STRONG><CODE>ssl_client_depth() -&#62; int()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY>

<P>      This function returns the SSL verification depth for outgoing calls. 
         The default value is configured by setting the application variable 
         <STRONG>ssl_client_depth</STRONG>.
        
</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>cosFileTransfer 1.1.2<BR>
Copyright &copy; 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>