commands/rsocket/rsocket.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # rsocket.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name rsocket
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Send and receive data via Symbian's C<RSocket> API.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 This command allows a TCP connection to be established using Symbian's C<RSocket> API. Currently, after establishing the connection it immediately disconnects. However, it is intended that future versions will support writing data read from STDIN to the socket and write data read from the socket to STDOUT.
       
    22 
       
    23 ==see-also
       
    24 
       
    25 L<iap|iap>, L<rconn|rconn>
       
    26 
       
    27 ==argument enum operation
       
    28 
       
    29 The operation required.
       
    30 
       
    31 ==enum-value connect
       
    32 
       
    33 Establish an active TCP connection to the specified host.
       
    34 
       
    35 ==enum-value listen
       
    36 
       
    37 Listen for incoming TCP connections on the specified port (not yet implemented).
       
    38 
       
    39 ==argument string host
       
    40 
       
    41 The name or IP address of the host to connect to or the interface to listen on.
       
    42 
       
    43 ==argument uint port
       
    44 
       
    45 The port of the host to connect to or the interface to listen on.
       
    46 
       
    47 ==option bool v verbose
       
    48 
       
    49 Print verbose output.
       
    50 
       
    51 ==option uint i iap
       
    52 
       
    53 The Internet Access Provider identifier to use.
       
    54 
       
    55 ==option uint n network
       
    56 
       
    57 The network identifier to use.
       
    58 
       
    59 ==copyright
       
    60 
       
    61 Copyright (c) 2009-2010 Accenture. All rights reserved.
       
    62