.. default-domain:: chpl

.. module:: Communication
   :synopsis: This module provides low-level communication procedures.

Communication
=============
**Usage**

.. code-block:: chapel

   use Communication;


or

.. code-block:: chapel

   import Communication;

.. warning::

   The Communication module is unstable and may change in the future


This module provides low-level communication procedures.

  .. warning::

   These procedures will perform very rudimentary error checking with checks
   enabled. Namely, only locale IDs and data sizes are checked to make sure
   they have reasonable values.  Validity of the addresses is not confirmed
   under any circumstance.


.. function:: proc get(dest: c_ptr(void), src: c_ptr(void), srcLocID: int, numBytes: integral)

   
   Copy potentially remote data into local memory.
   
   :arg dest: Address in local memory where the data will be copied into
   :arg src: Address of the source in potentially remote memory
   :arg srcLocID: ID of the source locale
   :arg numBytes: Number of bytes to copy
   

.. function:: proc put(dest: c_ptr(void), src: c_ptr(void), destLocID: int, numBytes: integral)

   
   Copy local data into potentially remote memory.
   
   :arg dest: Address in potentially remote memory where the data will be copied
              into
   :arg src: Address of the source in local memory
   :arg destLocID: ID of the destination locale
   :arg numBytes: Number of bytes to copy