mongoclient.close(3) [php man page]

MONGOCLIENT.CLOSE(3)							 1						      MONGOCLIENT.CLOSE(3)

MongoClient::close - Closes this connection

SYNOPSIS

       public bool MongoClient::close ([boolean|string	$connection])

DESCRIPTION

	The  MongoClient.close(3) method forcefully closes a connection to the database, even if persistent connections are being used. You should
       never have to do this under normal circumstances.

PARAMETERS

	      o $connection
		- If connection is not given, or FALSE then connection that would be selected for writes would be closed. In a single-node config-
		uration,  that	is then the whole connection, but if you are connected to a replica set, close() will only close the connection to
		the primary server.  If connection is TRUE then all connections as known by the  connection  manager  will  be	closed.  This  can
		include  connections that are not referenced in the connection string used to create the object that you are calling close on.	If
		connection is a string argument, then it will only close the connection identified by this hash. Hashes are identifiers for a con-
		nection and can be obtained by calling MongoClient.getConnections(3).

RETURN VALUES

	Returns if the connection was successfully closed.

EXAMPLES

       Example #1

	      MongoClient.close(3) example

	      This example demonstrates how to selectively close all connections for secondaries only.

	      <?php
	      // Connect to a replicaset
	      $a = new MongoClient("mongodb://whisky:13000/?replicaset=seta");

	      $connections = $a->getConnections();

	      foreach ( $connections as $con )
	      {
		  // Loop over all the connections, and when the type is "SECONDARY"
		  // we close the connection
		  if ( $con['connection']['connection_type_desc'] == "SECONDARY" )
		  {
		      echo "Closing '{$con['hash']}': ";
		      $closed = $a->close( $con['hash'] );
		      echo $closed ? "ok" : "failed", "
";
		  }
	      }
	      ?>

	      The above example will output:

	      Closing 'whisky:13001;X;4948': ok

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.3.0	|						    |
       |	|						    |
       |	|  The	$connection  parameter to this function was |
       |	| added in 1.3.0. Before that, only the write  con- |
       |	| nection would be closed by this method.	    |
       |	|						    |
       | 1.2.0	|						    |
       |	|						    |
       |	|  Before  version  1.2.0  the driver would not use |
       |	| persistent connections by default, and  all  con- |
       |	| nections  would  be  closed  as soon as a MongoDB |
       |	| connection went out if scope. Since version 1.2.0 |
       |	| this	is  no longer the case and it is a bad idea |
       |	| to call close as you might end up overloading the |
       |	| server with connections under high load.	    |
       |	|						    |
       +--------+---------------------------------------------------+
SEE ALSO 
MongoClient.getConnections(3).
PHP Documentation Group 												      MONGOCLIENT.CLOSE(3)

Check Out this Related Man Page

MYSQLI_PING(3)								 1							    MYSQLI_PING(3)

mysqli::ping - Pings a server connection, or tries to reconnect if the connection has gone down

       Object oriented style

SYNOPSIS

       bool mysqli::ping (void	)

DESCRIPTION

       Procedural style
       bool mysqli_ping (mysqli  $link)

	Checks	whether  the  connection to the server is working. If it has gone down, and global option mysqli.reconnect is enabled an automatic
       reconnection is attempted.

	This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection  and  recon-
       nect if necessary.

PARAMETERS

	      o $
		link -Procedural style only: A link identifier returned by mysqli_connect(3) or mysqli_init(3)

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      mysqli::ping example

	      Object oriented style

	      <?php
	      $mysqli = new mysqli("localhost", "my_user", "my_password", "world");

	      /* check connection */
	      if ($mysqli->connect_errno) {
		  printf("Connect failed: %s
", $mysqli->connect_error);
		  exit();
	      }

	      /* check if server is alive */
	      if ($mysqli->ping()) {
		  printf ("Our connection is ok!
");
	      } else {
		  printf ("Error: %s
", $mysqli->error);
	      }

	      /* close connection */
	      $mysqli->close();
	      ?>

	      Procedural style

	      <?php
	      $link = mysqli_connect("localhost", "my_user", "my_password", "world");

	      /* check connection */
	      if (mysqli_connect_errno()) {
		  printf("Connect failed: %s
", mysqli_connect_error());
		  exit();
	      }

	      /* check if server is alive */
	      if (mysqli_ping($link)) {
		  printf ("Our connection is ok!
");
	      } else {
		  printf ("Error: %s
", mysqli_error($link));
	      }

	      /* close connection */
	      mysqli_close($link);
	      ?>

	      The above examples will output:

	      Our connection is ok!

PHP Documentation Group 													    MYSQLI_PING(3)

Linux and UNIX Man Pages

mongoclient.close(3) [php man page]

Check Out this Related Man Page