Revision: 3fda98b6544f
Author: Vinu S Renish <[email protected]>
Date: Mon Aug 13 03:00:07 2012
Log: neatness and wrap
http://code.google.com/p/jss7/source/detail?r=3fda98b6544f
Modified:
/m3ua/cli/sctp/src/main/resources/help/sctp.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_create.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_destroy.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_show.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_create
/m3ua/cli/sctp/src/main/resources/help/sctp_server_create.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_destroy.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_show.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_start.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_stop.txt
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp.txt Thu Aug 9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp.txt Mon Aug 13 03:00:07 2012
@@ -11,8 +11,13 @@
Command Line parameters.
DESCRIPTION
- This command is used to manage M3UA - SCTP. You can create, destroy,
start and stop a SCTP Server and view the Server configuration using the
sctp server command. You can create, destroy and view SCTP Associations
using the sctp association command.
+ This command is used to manage M3UA - SCTP. You can create, destroy,
start and
+ stop a SCTP Server and view the Server configuration using the sctp
server
+ command. You can create, destroy and view SCTP Associations using the
+ sctp association command.
SEE ALSO
- sctp server create, sctp server destroy, sctp server start, sctp server
stop, sctp server show, sctp association create, sctp association destroy,
sctp association show
+ sctp server create, sctp server destroy, sctp server start, sctp server
stop,
+ sctp server show, sctp association create, sctp association destroy,
+ sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_association_create.txt Thu
Aug 9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_create.txt Mon
Aug 13 03:00:07 2012
@@ -2,41 +2,98 @@
sctp association create
SYNOPSIS
- sctp association create <assoc-name> <CLIENT | SERVER> <server-name>
<peer-ip> <peer-port> <host- ip> <host-port> <socket-type>
+ sctp association create <assoc-name> <CLIENT | SERVER> <server-name>
<peer-ip>
+ <peer-port> <host- ip> <host-port> <socket-type>
DESCRIPTION
- This command is used to create a new SCTP (Client side or Server side)
association.
+ This command is used to create a new SCTP (Client side or Server side)
+ association.
PARAMETERS
Standard Parameters
- <assoc-name> - Name of the new Association created. This must be unique
and takes any String value.
+ <assoc-name> - Name of the new Association created.
This must be
+ unique and takes any String value.
- <CLIENT | SERVER> - Specify if this association is client side or server
side. If it is client side, it will initiate the connection to peer. If it
is server side, it will wait for peer to initiate the connection. The
connection request will be accepted from peer-ip: peer:port.
+ <CLIENT | SERVER> - Specify if this association is client side or
+ server side. If it is client side, it
will
+ initiate the connection to peer. If it
is server
+ side, it will wait for peer to initiate
the
+ connection. The connection request will
be
+ accepted from peer-ip: peer:port.
- <peer-ip> -
+ <peer-ip> - In a client side association, the server IP
+ address to which the client is
connecting to.
+
+ In a server side association, the
client IP
+ address from which connections will be
accepted.
- <peer-port> -
+ <peer-port> - In a client side association, the
server Port
+ to which the client is connecting to.
- <host-ip> - In a client side association, the host IP address to which
the Association will bind to. For SCTP multi-home support, you can pass
multiple IP addresses as comma separated values. The Association will bind
to the primary IP address and when it becomes unavailable, it will
automatically fall back to secondary address. If the socket-type is TCP,
these comma separated values will be ignored and the Assocation will always
bind to the primary IP address (the first value in the comma separated
list). This is required only for a client side Association. For a server
side association, even if you specify these values it will be ignored.
+ In a server side association, the
client port from
+ which connections will be accepted.
+
+ <host-ip> - In a client side association, the local IP
address
+ to which the socket will bind to.
+
+ For SCTP multi-home support, you can
pass multiple
+ IP addresses as comma separated values.
The
+ Association will bind to the primary IP
address
+ and when it becomes unavailable, it will
+ automatically fall back to secondary
address.
+ If the socket-type is TCP, these comma
separated
+ values will be ignored and the
Assocation will
+ always bind to the primary IP address
(the first
+ value in the comma separated list).
This is
+ required only for a client side
Association.
+
+ For a server side association, even if
you specify
+ these values it will be ignored.
- <host-port> - In a client side association, the host port to which the
Association will bind to. This is required only for a client side
Association. For a server side association, even if you specify these
values it will be ignored.
+ <host-port> - In a client side association, the
local port to
+ which the socket will bind to. This is
+ required only for a client side
Association.
+
+ For a server side association, even if
you specify
+ these values it will be ignored.
- <server-name> - In a server-side association, the server-name must be
passed to associate with the Server identified by that name. You must
ensure that the Server identified by server-name has already been created
using the sctp server create command. In a client-side association, this is
not required and you should not pass this parameter.
+ <server-name> - In a server-side association, the
server-name must
+ be passed to associate with the Server
identified
+ by that name. You must ensure that the
Server
+ identified by server-name has already
been created
+ using the sctp server create command.
+
+ In a client-side association, this is
not required
+ and you should not pass this parameter.
Optional Parameters
- <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP. If it is a SERVER SCTP Association, the
socket-type must match with the one specified while creating the Server.
+ <socket-type> - If you do not specify the socket-type as
"TCP",
+ by default it will be SCTP. If it is a
+ SERVER SCTP Association, the
socket-type must
+ match with the one specified while
creating the
+ Server.
EXAMPLES
- sctp association create Assoc1 CLIENT 192.168.56.101 2905
192.168.56.1,192.168.56.1 2905
- - The above command will create a new CLIENT SCTP Association identified
as Assoc1. The client side will initiate the connection. It will bind the
host-ip 192.168.56.1 and host-port 2905 to peer-ip 192.168.56.101 and
peer-port 2905.
+ sctp association create Assoc1 CLIENT
+ 192.168.56.101 2905 192.168.56.1,192.168.56.1 2905
+
+ The above command will create a new CLIENT SCTP Association identified as
Assoc1.
+ The client side will initiate the connection. It will bind the
+ host-ip 192.168.56.1 and host-port 2905 to the Server IP 192.168.56.101
and
+ port 2905.
sctp association create Assoc2 SERVER TestServer 192.168.56.1 2905
- - The above command will create a new SERVER SCTP association with the
Server identified as TestServer and accept connections from peer whose IP
address is 192.168.56.1 and port 2905.
+
+ The above command will create a new SERVER SCTP association with the
Server
+ identified as TestServer and accept connections from peer whose IP
address is
+ 192.168.56.1 and port 2905.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association destroy, sctp association
show
+ sctp, sctp server create, sctp server destroy, sctp server start,
+ sctp server stop, sctp server show, sctp association destroy,
+ sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_association_destroy.txt Thu
Aug 9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_destroy.txt Mon
Aug 13 03:00:07 2012
@@ -5,7 +5,8 @@
sctp association destroy <assoc-name>
DESCRIPTION
- This command is used to delete an existing SCTP Association identified by
the name assoc-name.
+ This command is used to delete an existing SCTP Association identified by
the
+ name assoc-name.
PARAMETERS
@@ -15,8 +16,10 @@
EXAMPLES
sctp association destroy Assoc1
- - The above command will destroy the Association identified by the name
Assoc1.
+
+ The above command will destroy the Association identified by the name
Assoc1.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association create, sctp association
show
+ sctp, sctp server create, sctp server destroy, sctp server start,
+ sctp server stop, sctp server show, sctp association create, sctp
association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_association_show.txt Thu
Aug 9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_show.txt Mon
Aug 13 03:00:07 2012
@@ -5,10 +5,20 @@
sctp association show
DESCRIPTION
- This command is used to view the details of all SCTP Associations
created. The information displayed will include the Association type
(SERVER or CLIENT), name of the Association, state (whether started=false
or true). For a CLIENT Association it will also display the host-ip,
host-port and peer-ip, peer-port values. For multi-home SCTP, it will
display all the IP addresses that are configured. For a SERVER Association,
it will display the configured peer-ip and peer-port values.
+ This command is used to view the details of all SCTP Associations
created.
+ The information displayed will include the Association type (SERVER or
CLIENT),
+ name of the Association, state (whether started=false or true). For a
CLIENT
+ Association it will also display the host-ip, host-port and peer-ip,
peer-port
+ values.
+
+ For multi-home SCTP, it will display all the IP addresses that are
configured.
+ For a SERVER Association, it will display the configured peer-ip and
peer-port
+ values.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association create, sctp association
destroy
+ sctp, sctp server create, sctp server destroy, sctp server start,
+ sctp server stop, sctp server show, sctp association create,
+ sctp association destroy
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_create Thu Aug 9
04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_create Mon Aug 13
03:00:07 2012
@@ -11,26 +11,48 @@
Standard Parameters
- <server-name> - Name of the new Server created. This must be unique and
takes any String value.
+ <server-name> - Name of the new Server created. This
must be
+ unique and takes any String value.
- <host-ip> - The host IP address to which the SCTP Server socket will
bind to. For SCTP multi-home support, you can pass multiple IP addresses as
comma separated values. The Server socket will bind to the primary IP
address and when it becomes unavailable, it will automatically fall back to
secondary address. If the socket-type is TCP, these comma separated values
will be ignored and the Server socket will always bind to the primary IP
address (the first value in the comma separated list).
+ <host-ip> - The host IP address to which the SCTP Server
+ socket will bind to.
- <host-port> - The host port to which the underlying SCTP Server socket
will bind to.
+ For SCTP multi-home support, you can
pass multiple
+ IP addresses as comma separated values.
The Server
+ socket will bind to the primary IP
address and
+ when it becomes unavailable, it will
automatically
+ fall back to secondary address. If the
socket-type
+ is TCP, these comma separated values
will be
+ ignored and the Server socket will
always bind to
+ the primary IP address (the first value
in the
+ comma separated list).
+
+ <host-port> - The host port to which the underlying
SCTP Server
+ socket will bind to.
Optional Parameters
- <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP.
+ <socket-type> - If you do not specify the socket-type as
"TCP",
+ by default it will be SCTP.
EXAMPLES
sctp server create TestServer 127.0.0.1 2905
- - The above command will create a new SCTP Server identified as
TestServer and bind the Server socket to the IP address 127.0.0.1 and port
2905.
+
+ The above command will create a new SCTP Server identified as TestServer
and bind
+ the Server socket to the IP address 127.0.0.1 and port 2905.
sctp server create TestServerMulti 10.2.50.145,10.2.50.146 2905
- - The above command will create a new SCTP Server identified as
TestServerMulti and bind the Server socket to the IP address 10.2.50.145
and port 2905. If 10.2.50.145 is unavailable, the Server will automatically
fall back to 10.2.50.146.
+
+ The above command will create a new SCTP Server identified as
TestServerMulti and
+ bind the Server socket to the IP address 10.2.50.145 and port 2905. If
10.2.50.145
+ is unavailable, the Server will automatically fall back to 10.2.50.146.
sctp server create TestServerTCP 127.0.0.1 2906 TCP
- - The above command will create a new TCP Server identified as
TestServerTCP and bind the socket to the IP address 127.0.0.1 and port 2906.
+
+ The above command will create a new TCP Server identified as
TestServerTCP and
+ bind the socket to the IP address 127.0.0.1 and port 2906.
SEE ALSO
- sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show,
+ sctp association create, sctp association destroy, sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_create.txt Thu Aug
9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_create.txt Mon Aug
13 03:00:07 2012
@@ -11,26 +11,48 @@
Standard Parameters
- <server-name> - Name of the new Server created. This must be unique and
takes any String value.
+ <server-name> - Name of the new Server created. This
must be
+ unique and takes any String value.
- <host-ip> - The host IP address to which the SCTP Server socket will
bind to. For SCTP multi-home support, you can pass multiple IP addresses as
comma separated values. The Server socket will bind to the primary IP
address and when it becomes unavailable, it will automatically fall back to
secondary address. If the socket-type is TCP, these comma separated values
will be ignored and the Server socket will always bind to the primary IP
address (the first value in the comma separated list).
+ <host-ip> - The host IP address to which the SCTP Server
+ socket will bind to.
+
+ For SCTP multi-home support, you can
pass multiple
+ IP addresses as comma separated values.
The Server
+ socket will bind to the primary IP
address and
+ when it becomes unavailable, it will
automatically
+ fall back to secondary address. If the
socket-type
+ is TCP, these comma separated values
will be
+ ignored and the Server socket will
always bind to
+ the primary IP address (the first value
in the
+ comma separated list).
- <host-port> - The host port to which the underlying SCTP Server socket
will bind to.
+ <host-port> - The host port to which the underlying
SCTP Server
+ socket will bind to.
Optional Parameters
- <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP.
+ <socket-type> - If you do not specify the socket-type as
"TCP",
+ by default it will be SCTP.
EXAMPLES
sctp server create TestServer 127.0.0.1 2905
- - The above command will create a new SCTP Server identified as
TestServer and bind the Server socket to the IP address 127.0.0.1 and port
2905.
+
+ The above command will create a new SCTP Server identified as TestServer
and bind
+ the Server socket to the IP address 127.0.0.1 and port 2905.
sctp server create TestServerMulti 10.2.50.145,10.2.50.146 2905
- - The above command will create a new SCTP Server identified as
TestServerMulti and bind the Server socket to the IP address 10.2.50.145
and port 2905. If 10.2.50.145 is unavailable, the Server will automatically
fall back to 10.2.50.146.
+
+ The above command will create a new SCTP Server identified as
TestServerMulti and
+ bind the Server socket to the IP address 10.2.50.145 and port 2905. If
10.2.50.145
+ is unavailable, the Server will automatically fall back to 10.2.50.146.
sctp server create TestServerTCP 127.0.0.1 2906 TCP
- - The above command will create a new TCP Server identified as
TestServerTCP and bind the socket to the IP address 127.0.0.1 and port 2906.
+
+ The above command will create a new TCP Server identified as
TestServerTCP and
+ bind the socket to the IP address 127.0.0.1 and port 2906.
SEE ALSO
- sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show,
+ sctp association create, sctp association destroy, sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_destroy.txt Thu Aug
9 04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_destroy.txt Mon Aug
13 03:00:07 2012
@@ -5,7 +5,8 @@
sctp server destroy <sever-name>
DESCRIPTION
- This command is used to delete an existing SCTP Server instance. You must
ensure that the Server is stopped prior to deletion.
+ This command is used to delete an existing SCTP Server instance. You must
ensure
+ that the Server is stopped prior to deletion.
PARAMETERS
@@ -15,9 +16,11 @@
EXAMPLES
sctp server destroy TestServer
- - The above command will destroy the Server identified by the name
TestServer.
+
+ The above command will destroy the Server identified by the name
TestServer.
SEE ALSO
- sctp, sctp server create, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server create, sctp server start, sctp server stop, sctp
server show,
+ sctp association create, sctp association destroy, sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_show.txt Thu Aug 9
04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_show.txt Mon Aug 13
03:00:07 2012
@@ -5,8 +5,14 @@
sctp server show
DESCRIPTION
- This command is used to view the details of all SCTP Server instances
created. The information displayed will include the socket type (SCTP or
TCP), name of the Server, state (whether started=false or true), the IP
address and port that the Server is bound to. For multi-home SCTP Servers
it will display all the IP addresses that are configured.
+ This command is used to view the details of all SCTP Server instances
created.
+ The information displayed will include the socket type (SCTP or TCP),
name of the
+ Server, state (whether started=false or true), the IP address and port
that the
+ Server is bound to. For multi-home SCTP Servers it will display all the
+ IP addresses that are configured.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server create, sctp server destroy, sctp server start,
+ sctp server stop, sctp association create, sctp association destroy,
+ sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_start.txt Thu Aug 9
04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_start.txt Mon Aug 13
03:00:07 2012
@@ -5,7 +5,10 @@
sctp server start <sever-name>
DESCRIPTION
- This command is used to start an existing SCTP Server instance. Upon
executing this command, the underlying SCTP server socket is bound to the
IP: Port configured for this Server instance at the time of creation using
the "sctp server create" command.
+ This command is used to start an existing SCTP Server instance. Upon
executing
+ this command, the underlying SCTP server socket is bound to the IP: Port
+ configured for this Server instance at the time of creation using the
+ "sctp server create" command.
PARAMETERS
@@ -15,7 +18,11 @@
EXAMPLES
sctp server start TestServer
- - The above command will start the previously created Server instance
identified by the name TestServer and bind the underlying socket to the IP
address and port configured for TestServer at the time of creation.
+
+ The above command will start the previously created Server instance
identified
+ by the name TestServer and bind the underlying socket to the IP address
and port
+ configured for TestServer at the time of creation.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server create, sctp server destroy, sctp server stop, sctp
server show,
+ sctp association create, sctp association destroy, sctp association show
=======================================
--- /m3ua/cli/sctp/src/main/resources/help/sctp_server_stop.txt Thu Aug 9
04:36:11 2012
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_stop.txt Mon Aug 13
03:00:07 2012
@@ -5,7 +5,9 @@
sctp server stop <sever-name>
DESCRIPTION
- This command is used to stop an existing SCTP Server instance. Upon
executing this command, the underlying SCTP server socket is closed and all
resources are released.
+ This command is used to stop an existing SCTP Server instance. Upon
executing this
+ command, the underlying SCTP server socket is closed and all resources
are
+ released.
PARAMETERS
@@ -15,8 +17,12 @@
EXAMPLES
sctp server stop TestServer
- - The above command will stop the currently running Server instance
identified by the name TestServer, close the underlying socket and release
all resources.
+
+ The above command will stop the currently running Server instance
identified by
+ the name TestServer, close the underlying socket and release all
resources.
SEE ALSO
- sctp, sctp server create, sctp server destroy, sctp server start, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+ sctp, sctp server create, sctp server destroy, sctp server start,
+ sctp server show, sctp association create, sctp association destroy,
+ sctp association show