Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > 675c8c8167236dfcf8d66da674f931e8 > files > 340

erlang-doc-R15B-03.3.fc17.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- cosFileTransferApp</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
            <!--
              function getWinHeight() {
                var myHeight = 0;
                if( typeof( window.innerHeight ) == 'number' ) {
                  //Non-IE
                  myHeight = window.innerHeight;
                } else if( document.documentElement && ( document.documentElement.clientWidth ||
                                                         document.documentElement.clientHeight ) ) {
                  //IE 6+ in 'standards compliant mode'
                  myHeight = document.documentElement.clientHeight;
                } else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
                  //IE 4 compatible
                  myHeight = document.body.clientHeight;
                }
                return myHeight;
              }

              function setscrollpos() {
                var objf=document.getElementById('loadscrollpos');
                 document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
              }

              function addEvent(obj, evType, fn){
                if (obj.addEventListener){
                obj.addEventListener(evType, fn, true);
                return true;
              } else if (obj.attachEvent){
                var r = obj.attachEvent("on"+evType, fn);
                return r;
              } else {
                return false;
              }
             }

             addEvent(window, 'load', setscrollpos);

             //--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/cosFileTransfer-1.1.13.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>cosFileTransfer</strong><br><strong>Reference Manual</strong><br><small>Version 1.1.13</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li id="loadscrollpos" title="cosFileTransferApp " expanded="true">cosFileTransferApp<ul>
<li><a href="cosFileTransferApp.html">
                  Top of manual page
                </a></li>
<li title="install-0"><a href="cosFileTransferApp.html#install-0">install/0</a></li>
<li title="uninstall-0"><a href="cosFileTransferApp.html#uninstall-0">uninstall/0</a></li>
<li title="start-0"><a href="cosFileTransferApp.html#start-0">start/0</a></li>
<li title="stop-0"><a href="cosFileTransferApp.html#stop-0">stop/0</a></li>
<li title="create_VFS-4"><a href="cosFileTransferApp.html#create_VFS-4">create_VFS/4</a></li>
<li title="ssl_server_certfile-0"><a href="cosFileTransferApp.html#ssl_server_certfile-0">ssl_server_certfile/0</a></li>
<li title="ssl_client_certfile-0"><a href="cosFileTransferApp.html#ssl_client_certfile-0">ssl_client_certfile/0</a></li>
<li title="ssl_server_verify-0"><a href="cosFileTransferApp.html#ssl_server_verify-0">ssl_server_verify/0</a></li>
<li title="ssl_client_verify-0"><a href="cosFileTransferApp.html#ssl_client_verify-0">ssl_client_verify/0</a></li>
<li title="ssl_server_depth-0"><a href="cosFileTransferApp.html#ssl_server_depth-0">ssl_server_depth/0</a></li>
<li title="ssl_client_depth-0"><a href="cosFileTransferApp.html#ssl_client_depth-0">ssl_client_depth/0</a></li>
</ul>
</li>
<li id="no" title="CosFileTransfer_File " expanded="false">CosFileTransfer_File<ul>
<li><a href="CosFileTransfer_File.html">
                  Top of manual page
                </a></li>
<li title="'_get_name'-1"><a href="CosFileTransfer_File.html#'_get_name'-1">'_get_name'/1</a></li>
<li title="'_get_complete_file_name'-1"><a href="CosFileTransfer_File.html#'_get_complete_file_name'-1">'_get_complete_file_name'/1</a></li>
<li title="'_get_parent'-1"><a href="CosFileTransfer_File.html#'_get_parent'-1">'_get_parent'/1</a></li>
<li title="'_get_associated_session'-1"><a href="CosFileTransfer_File.html#'_get_associated_session'-1">'_get_associated_session'/1</a></li>
</ul>
</li>
<li id="no" title="CosFileTransfer_Directory " expanded="false">CosFileTransfer_Directory<ul>
<li><a href="CosFileTransfer_Directory.html">
                  Top of manual page
                </a></li>
<li title="list-2"><a href="CosFileTransfer_Directory.html#list-2">list/2</a></li>
</ul>
</li>
<li id="no" title="CosFileTransfer_FileIterator " expanded="false">CosFileTransfer_FileIterator<ul>
<li><a href="CosFileTransfer_FileIterator.html">
                  Top of manual page
                </a></li>
<li title="next_one-1"><a href="CosFileTransfer_FileIterator.html#next_one-1">next_one/1</a></li>
<li title="next_n-2"><a href="CosFileTransfer_FileIterator.html#next_n-2">next_n/2</a></li>
<li title="destroy-1"><a href="CosFileTransfer_FileIterator.html#destroy-1">destroy/1</a></li>
</ul>
</li>
<li id="no" title="CosFileTransfer_VirtualFileSystem " expanded="false">CosFileTransfer_VirtualFileSystem<ul>
<li><a href="CosFileTransfer_VirtualFileSystem.html">
                  Top of manual page
                </a></li>
<li title="'_get_file_system_type'-1"><a href="CosFileTransfer_VirtualFileSystem.html#'_get_file_system_type'-1">'_get_file_system_type'/1</a></li>
<li title="'_get_supported_content_types'-1"><a href="CosFileTransfer_VirtualFileSystem.html#'_get_supported_content_types'-1">'_get_supported_content_types'/1</a></li>
<li title="login-4"><a href="CosFileTransfer_VirtualFileSystem.html#login-4">login/4</a></li>
</ul>
</li>
<li id="no" title="CosFileTransfer_FileTransferSession " expanded="false">CosFileTransfer_FileTransferSession<ul>
<li><a href="CosFileTransfer_FileTransferSession.html">
                  Top of manual page
                </a></li>
<li title="'_get_protocols_supported'-1"><a href="CosFileTransfer_FileTransferSession.html#'_get_protocols_supported'-1">'_get_protocols_supported'/1</a></li>
<li title="set_directory-2"><a href="CosFileTransfer_FileTransferSession.html#set_directory-2">set_directory/2</a></li>
<li title="create_file-2"><a href="CosFileTransfer_FileTransferSession.html#create_file-2">create_file/2</a></li>
<li title="create_directory-2"><a href="CosFileTransfer_FileTransferSession.html#create_directory-2">create_directory/2</a></li>
<li title="get_file-2"><a href="CosFileTransfer_FileTransferSession.html#get_file-2">get_file/2</a></li>
<li title="delete-2"><a href="CosFileTransfer_FileTransferSession.html#delete-2">delete/2</a></li>
<li title="transfer-3"><a href="CosFileTransfer_FileTransferSession.html#transfer-3">transfer/3</a></li>
<li title="append-3"><a href="CosFileTransfer_FileTransferSession.html#append-3">append/3</a></li>
<li title="insert-4"><a href="CosFileTransfer_FileTransferSession.html#insert-4">insert/4</a></li>
<li title="logout-1"><a href="CosFileTransfer_FileTransferSession.html#logout-1">logout/1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><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>
    <p>To get access to the record definitions for the structures use:      <br>
<span class="code">-include_lib("cosFileTransfer/include/*.hrl").</span></p>
    <p>This module contains the functions for starting and stopping the application.</p>
  </p></div>
  <h3>EXPORTS</h3>
    <p><a name="install-0"><span class="bold_code">install() -&gt; Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
        <div class="REFTYPES">
<span class="bold_code">Return = ok | {'EXIT', Reason}</span><br>
</div>
      </div>
<div class="REFBODY"><p>
        <p>This operation installs the cosFileTransfer application. Note, the
          <span class="code">cosProperty</span> application must be installed prior to invoking this
          operation.</p>
      </p></div>
    <p><a name="uninstall-0"><span class="bold_code">uninstall() -&gt; Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
        <div class="REFTYPES">
<span class="bold_code">Return = ok | {'EXIT', Reason}</span><br>
</div>
      </div>
<div class="REFBODY"><p>
        <p>This operation uninstalls the cosFileTransfer application.</p>
      </p></div>
    <p><a name="start-0"><span class="bold_code">start() -&gt; Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
        <div class="REFTYPES">
<span class="bold_code">Return = ok | {error, Reason}</span><br>
</div>
      </div>
<div class="REFBODY"><p>
        <p>This operation starts the cosFileTransfer application.</p>
      </p></div>
    <p><a name="stop-0"><span class="bold_code">stop() -&gt; Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
        <div class="REFTYPES">
<span class="bold_code">Return = ok | {error, Reason}</span><br>
</div>
      </div>
<div class="REFBODY"><p>
        <p>This operation stops the cosFileTransfer application.</p>
      </p></div>
    <p><a name="create_VFS-4"><span class="bold_code">create_VFS(Type, Content, Host, Port [,Options]) -&gt; Return</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
        <div class="REFTYPES">
<span class="bold_code">Type = 'FTP' | {'NATIVE', 'cosFileTransferNATIVE_file'} |  {'NATIVE', MyModule}</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Content = []</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Host = string(), e.g. "myHost@myServer" or "012.345.678.910"</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Port = integer()</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Options = [Option]</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Option = {protocol, Protocol} | {connect_timeout, Seconds}</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Protocol = tcp | ssl</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">Return = VFS | {'EXCEPTION, E}</span><br>
</div>
        <div class="REFTYPES">
<span class="bold_code">VFS = #objref</span><br>
</div>
      </div>
<div class="REFBODY"><p>
        <p>This operation creates a new instance of a Virtual File System. The 
          <span class="code">Type</span> parameter determines which type we want the VFS to represent.
          'FTP' maps to the <span class="code">INETS</span> ftp implementation, while
          {'NATIVE', 'cosFileTransferNATIVE_file'} uses the <span class="code">file</span> 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 <span class="code">open(Host, Port)</span>, which shall return 
          <span class="code">{ok, Pid}</span> or <span class="code">{error, Reason}</span>.</p>
        <p>If no <span class="code">Options</span> are supplied the default setting will be
          used, i.e., tcp and 60 seconds.</p>
        <p>The <span class="code">Content</span> parameter is currently ignored by must be supplied
          as an empty list.</p>
      </p></div>
    <p><a name="ssl_server_certfile-0"><span class="bold_code">ssl_server_certfile() -&gt; string()</span></a><br></p>
<div class="REFBODY"><p>
        <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>.</p>
      </p></div>
    <p><a name="ssl_client_certfile-0"><span class="bold_code">ssl_client_certfile() -&gt; string()</span></a><br></p>
<div class="REFBODY"><p>
        <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>.</p>
      </p></div>
    <p><a name="ssl_server_verify-0"><span class="bold_code">ssl_server_verify() -&gt; 0 | 1 | 2</span></a><br></p>
<div class="REFBODY"><p>
        <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>.</p>
      </p></div>
    <p><a name="ssl_client_verify-0"><span class="bold_code">ssl_client_verify() -&gt; 0 | 1 | 2</span></a><br></p>
<div class="REFBODY"><p>
        <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>.</p>
      </p></div>
    <p><a name="ssl_server_depth-0"><span class="bold_code">ssl_server_depth() -&gt; int()</span></a><br></p>
<div class="REFBODY"><p>
        <p>This function returns the SSL verification depth for incoming calls. 
          It is configured by setting the application variable 
          <strong>ssl_server_depth</strong>.</p>
      </p></div>
    <p><a name="ssl_client_depth-0"><span class="bold_code">ssl_client_depth() -&gt;  int()</span></a><br></p>
<div class="REFBODY"><p>
        <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>.</p>
      </p></div>
  
  
</div>
<div class="footer">
<hr>
<p>Copyright © 2000-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional