3.2.3 Management Server Handle Functions

This section provides information about MGM API functions used to create and destroy management server handles (see NdbMgmHandle).

• ndb_mgm_create_handle()

• ndb_mgm_set_name()

• ndb_mgm_set_ignore_sigpipe()

• ndb_mgm_destroy_handle()

ndb_mgm_create_handle()

Description

This function is used to create a handle to a management server.

Signature

NdbMgmHandle ndb_mgm_create_handle
    (
      void
    )

Parameters

None.

Return value

An NdbMgmHandle.

ndb_mgm_set_name()

Description

This function can be used to set a name for the management server handle, which is then reported in the Cluster log.

Signature

void ndb_mgm_set_name
    (
      NdbMgmHandle handle,
      const char*  name
    )

Parameters

This function takes two arguments:

• A management server handle.

• The desired name for the handle.

Return value

None.

ndb_mgm_set_ignore_sigpipe()

Description

The MGM API by default installs a signal handler that ignores all SIGPIPE signals that might occur when writing to asocket that has been closed or reset. An application that provides its own handler for SIGPIPE should call this function after creating the management server handle and before using the handle to connect to the management server. (In other words, call this function after using ndb_mgm_create_handle() but before calling ndb_mgm_connect(), which causes the MGM API's SIGPIPE handler to be installed unless overridden.)

Signature

int ndb_mgm_set_ignore_sigpipe
    (
      NdbMgmHandle handle,
      int ignore = 1
    )

Parameters

This function takes two parameters:

• A management server handle

• An integer value which determines whether to ignore SIGPIPE errors. Set this to 1 (the default) to cause the MGM API to ignore SIGPIPE; set to zero if you wish for SIGPIPE to propagate to your MGM API application.

Return value

None.

ndb_mgm_destroy_handle()

Description

This function destroys a management server handle

Signature

void ndb_mgm_destroy_handle
    (
      NdbMgmHandle* handle
    )

Parameters

A pointer to the NdbMgmHandle to be destroyed.

Return value

None.