Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
Transfer Download [OPENAPI_TRANSFER]

Enumerations

enum  OPEN_COPY_CONFIG_DIRECTIVE_t { OPEN_COPY_CONFIG_DIRECTIVE_RTOF = 1, OPEN_COPY_CONFIG_DIRECTIVE_RTOS = 2, OPEN_COPY_CONFIG_DIRECTIVE_STOB = 3, OPEN_COPY_CONFIG_DIRECTIVE_BTOS = 4 }
 OPEN Configuration File Copy Combinations. More...
 
enum  OPEN_DIGITAL_SIGNATURE_OPTION_t {
  OPEN_DIGITAL_SIGNATURE_VERIFY_NONE = 0, OPEN_DIGITAL_SIGNATURE_VERIFY_IMAGE_ONLY = 1, OPEN_DIGITAL_SIGNATURE_VERIFY_CONFIG_SCRIPT_ONLY = 2, OPEN_DIGITAL_SIGNATURE_VERIFY_ALL = 3,
  OPEN_DIGITAL_SIGNATURE_VERIFY_LAST = 4
}
 OPEN Image Verification Options. More...
 
enum  OPEN_FILE_TYPES_t {
  OPEN_FILE_TYPE_NONE = 0, OPEN_FILE_TYPE_CODE = 1, OPEN_FILE_TYPE_CONFIG = 2, OPEN_FILE_TYPE_BACKUP_CONFIG = 3,
  OPEN_FILE_TYPE_LAST = 4
}
 OPEN File Types. More...
 
enum  OPEN_TRANSFER_CODE_t {
  OPEN_TRANSFER_CODE_NONE = 0, OPEN_TRANSFER_CODE_STARTING = 1, OPEN_TRANSFER_CODE_ERROR_STARTING = 2, OPEN_TRANSFER_CODE_WRONG_FILE_TYPE = 3,
  OPEN_TRANSFER_CODE_UPDATE_CONFIG = 4, OPEN_TRANSFER_CODE_INVALID_CONFIG = 5, OPEN_TRANSFER_CODE_WRITING_FLASH = 6, OPEN_TRANSFER_CODE_FLASH_FAILED = 7,
  OPEN_TRANSFER_CODE_CHECKING_CRC = 8, OPEN_TRANSFER_CODE_CRC_FAILURE = 9, OPEN_TRANSFER_CODE_UNKNOWN_DIRECTION = 10, OPEN_TRANSFER_CODE_SUCCESS = 11,
  OPEN_TRANSFER_CODE_FAILURE = 12, OPEN_TRANSFER_CODE_WRONG_DEVICE = 13, OPEN_TRANSFER_CODE_INSUFFICIENT_MEMORY = 14, OPEN_TRANSFER_CODE_FLASH_FILE_OPEN_FAIL = 15,
  OPEN_TRANSFER_CODE_ERROR_READING_FROM_FLASH = 16, OPEN_TRANSFER_CODE_FILE_DOES_NOT_EXISTS = 17, OPEN_TRANSFER_CODE_FILE_TOO_BIG = 18, OPEN_TRANSFER_CODE_ERROR_WRITING_TO_FLASH = 19,
  OPEN_TRANSFER_CODE_OVERWRITE_DENIED = 20, OPEN_TRANSFER_CODE_LAST = 21
}
 OPEN File Transfer Code.
 
enum  OPEN_TRANSFER_MODES_t {
  OPEN_TRANSFER_NONE = 0, OPEN_TRANSFER_TFTP = 1, OPEN_TRANSFER_SFTP = 2, OPEN_TRANSFER_SCP = 3,
  OPEN_TRANSFER_HTTP = 4, OPEN_TRANSFER_HTTPS = 5, OPEN_TRANSFER_LAST = 6
}
 OPEN File Transfer Types. More...
 
enum  OPEN_TRANSFER_STATUS_t {
  OPEN_NO_STATUS_CHANGE = 1, OPEN_STATUS_CHANGED = 2, OPEN_TRANSFER_FAILED = 3, OPEN_TRANSFER_BAD_CRC = 4,
  OPEN_FLASH_FAILED = 5, OPEN_OPR_FILE_TYPE_FAILED = 6, OPEN_OTHER_FILE_TYPE_FAILED = 7, OPEN_NEXT_DATA_BLOCK_RECEIVED = 8,
  OPEN_TRANSFER_FILE_NOT_FOUND = 9, OPEN_TRANSFER_SUCCESS = 10, OPEN_TFTP_FAILED = 11, OPEN_OPR_FILE_VERSION_FAILED = 12,
  OPEN_DIGITAL_SIGNATURE_VERIFY_FAILED = 13, OPEN_DIGITAL_SIGNATURE_TRUNCATE_FAILED = 14, OPEN_TRANSFER_STATUS_LAST = 15
}
 OPEN File Transfer Status.
 

Functions

open_error_t openapiCopyConfigFile (openapiClientHandle_t *client_handle, OPEN_COPY_CONFIG_DIRECTIVE_t directive)
 This API copies configuration files that are located on the switch. More...
 
open_error_t openapiDigitalSignatureVerifyConfigGet (openapiClientHandle_t *client_handle, OPEN_DIGITAL_SIGNATURE_OPTION_t *dsvConfigOption)
 To get the option to verify digital signature of downloaded file. More...
 
open_error_t openapiDigitalSignatureVerifyConfigSet (openapiClientHandle_t *client_handle, OPEN_DIGITAL_SIGNATURE_OPTION_t dsvConfigOption)
 To set the option to verify digital signature of downloaded file. More...
 
open_error_t openapiHttpTransferDownStartSet (openapiClientHandle_t *client_handle, open_buffdesc *filePathBuf, open_buffdesc *fileNameBuf)
 Completes an HTTP(S) file download transfer operation. More...
 
open_error_t openapiImageHeaderCheck (openapiClientHandle_t *client_handle, open_buffdesc *headerData, OPEN_BOOL_t *isValid)
 Test an image file header to determine if it is appropriate for this device. More...
 
open_error_t openapiImageHeaderSizeGet (openapiClientHandle_t *client_handle, uint32_t *headerSize)
 Determine the size the image file header for this device. More...
 
open_error_t openapiTransferDownloadResultCodeGet (openapiClientHandle_t *client_handle, OPEN_TRANSFER_CODE_t *resultCode)
 To retrieve the status of a transfer operation. More...
 
open_error_t openapiTransferDownStartSet (openapiClientHandle_t *client_handle)
 Starts an asynchronous file download transfer operation. More...
 
open_error_t openapiTransferFileLocalGet (openapiClientHandle_t *client_handle, open_buffdesc *imageLabel)
 Get the label by which the file to be transferred is known by on the local system. More...
 
open_error_t openapiTransferFileLocalSet (openapiClientHandle_t *client_handle, open_buffdesc *imageLabel)
 Set the label by which the file to be transferred is known by on the local system. More...
 
open_error_t openapiTransferFileRemoteGet (openapiClientHandle_t *client_handle, open_buffdesc *filePath, open_buffdesc *fileName)
 Get the path and name of the file on the remote system that is designated for transfer. More...
 
open_error_t openapiTransferFileRemoteSet (openapiClientHandle_t *client_handle, open_buffdesc *filePath, open_buffdesc *fileName)
 Set the path and name of the file on the remote system that is designated for transfer. More...
 
open_error_t openapiTransferFileTypeGet (openapiClientHandle_t *client_handle, OPEN_FILE_TYPES_t *fileType)
 Get the Transfer File Type. More...
 
open_error_t openapiTransferFileTypeSet (openapiClientHandle_t *client_handle, OPEN_FILE_TYPES_t fileType)
 Set the Transfer File Type. More...
 
open_error_t openapiTransferInProgressGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *isInProgress)
 Retrieve the progress of a file transfer. More...
 
open_error_t openapiTransferModeGet (openapiClientHandle_t *client_handle, OPEN_TRANSFER_MODES_t *xfrMode)
 Get the current transfer mode. More...
 
open_error_t openapiTransferModeSet (openapiClientHandle_t *client_handle, OPEN_TRANSFER_MODES_t xfrMode)
 Set the current transfer mode. More...
 
open_error_t openapiTransferRemoteUserCredentialsGet (openapiClientHandle_t *client_handle, open_buffdesc *username, open_buffdesc *password)
 Get the credentials (username and password) of remote host that will serve the file during the transfer operation. More...
 
open_error_t openapiTransferRemoteUserCredentialsSet (openapiClientHandle_t *client_handle, open_buffdesc *username, open_buffdesc *password)
 Set the credentials (username and password) of remote host that will serve the file during the transfer operation. More...
 
open_error_t openapiTransferResultGet (openapiClientHandle_t *client_handle, OPEN_TRANSFER_STATUS_t *resultCode, open_buffdesc *resultStatus)
 To retrieve the status of a transfer task in string format. More...
 
open_error_t openapiTransferServerAddressGet (openapiClientHandle_t *client_handle, open_inet_addr_t *inetAddr)
 Get the transfer server address. More...
 
open_error_t openapiTransferServerAddressSet (openapiClientHandle_t *client_handle, open_inet_addr_t inetAddr)
 Set the transfer server address. More...
 

Detailed Description

Enumeration Type Documentation

OPEN Configuration File Copy Combinations.

Enumerator
OPEN_COPY_CONFIG_DIRECTIVE_RTOF 

"running-config" to "factory-default"

OPEN_COPY_CONFIG_DIRECTIVE_RTOS 

"running-config" to "startup-config"

OPEN_COPY_CONFIG_DIRECTIVE_STOB 

"startup-config" to "backup-config"

OPEN_COPY_CONFIG_DIRECTIVE_BTOS 

"backup-config" to "startup-config"

Definition at line 123 of file openapi_transfer.h.

OPEN Image Verification Options.

Enumerator
OPEN_DIGITAL_SIGNATURE_VERIFY_NONE 

No Digital Signature verify for all downloads.

OPEN_DIGITAL_SIGNATURE_VERIFY_IMAGE_ONLY 

Digital Signature verify for Image download only.

OPEN_DIGITAL_SIGNATURE_VERIFY_CONFIG_SCRIPT_ONLY 

Digital Signature verify for config script download only.

OPEN_DIGITAL_SIGNATURE_VERIFY_ALL 

Digital Signature verify for all downloads.

OPEN_DIGITAL_SIGNATURE_VERIFY_LAST 

For bounds checking.

Definition at line 113 of file openapi_transfer.h.

OPEN File Types.

Enumerator
OPEN_FILE_TYPE_NONE 

Invalid file type.

OPEN_FILE_TYPE_CODE 

Compressed executable.

OPEN_FILE_TYPE_CONFIG 

Configuration file.

OPEN_FILE_TYPE_BACKUP_CONFIG 

Backup Configuration file.

OPEN_FILE_TYPE_LAST 

For bounds checking.

Definition at line 56 of file openapi_transfer.h.

OPEN File Transfer Types.

Enumerator
OPEN_TRANSFER_NONE 

Invalid xfer type.

OPEN_TRANSFER_TFTP 

Transfer via tftp.

OPEN_TRANSFER_SFTP 

Transfer via sftp.

OPEN_TRANSFER_SCP 

Transfer via scp.

OPEN_TRANSFER_HTTP 

Transfer via http.

OPEN_TRANSFER_HTTPS 

Transfer via https.

OPEN_TRANSFER_LAST 

For bounds checking.

Definition at line 44 of file openapi_transfer.h.

Function Documentation

open_error_t openapiCopyConfigFile ( openapiClientHandle_t client_handle,
OPEN_COPY_CONFIG_DIRECTIVE_t  directive 
)

This API copies configuration files that are located on the switch.

The source and destination files as well as their direction is limited to those defined in OPEN_COPY_CONFIG_DIRECTIVE_t.

Parameters
[in]client_handleClient handle from registration API.
[in]directiveSource to destination definition.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.20

Examples:
transfer_example.c.
open_error_t openapiDigitalSignatureVerifyConfigGet ( openapiClientHandle_t client_handle,
OPEN_DIGITAL_SIGNATURE_OPTION_t dsvConfigOption 
)

To get the option to verify digital signature of downloaded file.

Parameters
[in]client_handleClient handle from registration API.
[out]dsvConfigOptionEnumerated value indicating the digital signature verify option.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiDigitalSignatureVerifyConfigSet ( openapiClientHandle_t client_handle,
OPEN_DIGITAL_SIGNATURE_OPTION_t  dsvConfigOption 
)

To set the option to verify digital signature of downloaded file.

Parameters
[in]client_handleClient handle from registration API.
[in]dsvConfigOptionEnumerated value indicating the digital signature verify option.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiHttpTransferDownStartSet ( openapiClientHandle_t client_handle,
open_buffdesc filePathBuf,
open_buffdesc fileNameBuf 
)

Completes an HTTP(S) file download transfer operation.

Parameters
[in]client_handleClient handle from registration API.
[in]filePathBufThe complete path to the downloaded file written into a temporary location by the webserver
[in]fileNameBufThe original source filename. Used when preserving its name.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.20

Note
Caller is responsible to check transfer progress and final result using openapiTransferInProgressGet() and openapiTransferResultGet().
This function will block management port access until complete.
This function must only be called after a webserver on the switch has finished the file transfer and the data is located in the file specified by filePathBuf.
open_error_t openapiImageHeaderCheck ( openapiClientHandle_t client_handle,
open_buffdesc headerData,
OPEN_BOOL_t isValid 
)

Test an image file header to determine if it is appropriate for this device.

Parameters
[in]client_handleClient handle from registration API.
[in]headerDataBuffer containing the file header from the beginning of the file. The size of which is determined by calling openapiImageHeaderSizeGet().
[out]isValidOPEN_TRUE indicates the code image is intended or suitable for this system, else OPEN_FALSE
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
The caller is responsible for sending the number of bytes directly from the top of the code image file.
Buffer containing the file header should have no more than OPENAPI_STK_HEADER_SIZE bytes.
Examples:
transfer_example.c.
open_error_t openapiImageHeaderSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  headerSize 
)

Determine the size the image file header for this device.

Parameters
[in]client_handleClient handle from registration API.
[out]headerSizeSize of the image file's header.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferDownloadResultCodeGet ( openapiClientHandle_t client_handle,
OPEN_TRANSFER_CODE_t resultCode 
)

To retrieve the status of a transfer operation.

Parameters
[in]client_handleClient handle from registration API.
[out]resultCodeEnumerated value indicating the transfer download result code
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferDownStartSet ( openapiClientHandle_t client_handle)

Starts an asynchronous file download transfer operation.

Parameters
[in]client_handleClient handle from registration API.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
Caller is responsible to check transfer progress and final result using openapiTransferInProgressGet() and openapiTransferResultGet().
Examples:
transfer_example.c.
open_error_t openapiTransferFileLocalGet ( openapiClientHandle_t client_handle,
open_buffdesc imageLabel 
)

Get the label by which the file to be transferred is known by on the local system.

Parameters
[in]client_handleClient handle from registration API.
[out]imageLabelLabel of the file on the local system
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
This API provides the identifying string (label) used to refer to the file residing in non-volatile memory on the switch, such as "active" or "backup".
Buffer size for image labels should be openapiImageFileNameMaxLengthGet().
Examples:
transfer_example.c.
open_error_t openapiTransferFileLocalSet ( openapiClientHandle_t client_handle,
open_buffdesc imageLabel 
)

Set the label by which the file to be transferred is known by on the local system.

Parameters
[in]client_handleClient handle from registration API.
[in]imageLabelLabel of the file on the local system
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
This API sets the identifying string (label) used to refer to the file residing in non-volatile memory on the switch, such as "active" or "backup".
The imageLabel should be no longer that openapiImageFileNameMaxLengthGet(). bytes
Examples:
transfer_example.c.
open_error_t openapiTransferFileRemoteGet ( openapiClientHandle_t client_handle,
open_buffdesc filePath,
open_buffdesc fileName 
)

Get the path and name of the file on the remote system that is designated for transfer.

Parameters
[in]client_handleClient handle from registration API.
[out]filePathPath to the file on the remote system
[out]fileNameName of the file on the remote system
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.
Note
Caller must provide a buffer for filePath of at least OPENAPI_FILEPATH_LEN_MAX bytes.
Caller must provide a buffer for fileName of at least OPENAPI_FILENAME_LEN_MAX bytes.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferFileRemoteSet ( openapiClientHandle_t client_handle,
open_buffdesc filePath,
open_buffdesc fileName 
)

Set the path and name of the file on the remote system that is designated for transfer.

Parameters
[in]client_handleClient handle from registration API.
[in]filePathPath to the file on the remote system
[in]fileNameName of the file on the remote system
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.
Note
The filePath should be no longer that OPENAPI_FILEPATH_LEN_MAX bytes
The fileName should be no longer that OPENAPI_FILENAME_LEN_MAX bytes

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferFileTypeGet ( openapiClientHandle_t client_handle,
OPEN_FILE_TYPES_t fileType 
)

Get the Transfer File Type.

Parameters
[in]client_handleClient handle from registration API.
[out]fileTypeCurrent file transfer type. OPEN_FILE_TYPES_t
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
Only OPEN_FILE_TYPE_CODE is supported by OpEN API for this release.
Examples:
transfer_example.c.
open_error_t openapiTransferFileTypeSet ( openapiClientHandle_t client_handle,
OPEN_FILE_TYPES_t  fileType 
)

Set the Transfer File Type.

Parameters
[in]client_handleClient handle from registration API.
[in]fileTypeOn success, transfer file type. OPEN_FILE_TYPES_t
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
Only OPEN_FILE_TYPE_CODE is supported by OpEN API for this release.
Examples:
transfer_example.c.
open_error_t openapiTransferInProgressGet ( openapiClientHandle_t client_handle,
OPEN_BOOL_t isInProgress 
)

Retrieve the progress of a file transfer.

Parameters
[in]client_handleClient handle from registration API.
[out]isInProgressOPEN_TRUE indicates a code download is in progress.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferModeGet ( openapiClientHandle_t client_handle,
OPEN_TRANSFER_MODES_t xfrMode 
)

Get the current transfer mode.

Parameters
[in]client_handleClient handle from registration API.
[out]xfrModeCurrently set transfer type. OPEN_TRANSFER_MODES_t
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferModeSet ( openapiClientHandle_t client_handle,
OPEN_TRANSFER_MODES_t  xfrMode 
)

Set the current transfer mode.

Parameters
[in]client_handleClient handle from registration API.
[in]xfrModeOn success, current transfer type. OPEN_TRANSFER_MODES_t
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferRemoteUserCredentialsGet ( openapiClientHandle_t client_handle,
open_buffdesc username,
open_buffdesc password 
)

Get the credentials (username and password) of remote host that will serve the file during the transfer operation.

Parameters
[in]client_handleClient handle from registration API.
[out]usernameRemote host username
[out]passwordRemote host password
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
This is used with SCP and SFTP file transfers only
The buffer for username should be at least OPENAPI_TRANSFER_USERNAME_LEN_MAX bytes.
The buffer password should be at least OPENAPI_TRANSFER_PASSWORD_LEN_MAX bytes.
Examples:
transfer_example.c.
open_error_t openapiTransferRemoteUserCredentialsSet ( openapiClientHandle_t client_handle,
open_buffdesc username,
open_buffdesc password 
)

Set the credentials (username and password) of remote host that will serve the file during the transfer operation.

Parameters
[in]client_handleClient handle from registration API.
[in]usernameRemote host username
[in]passwordRemote host password
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
This is used with SCP and SFTP file transfers only
The username should be no longer than OPENAPI_TRANSFER_USERNAME_LEN_MAX bytes.
The password should be no longer than OPENAPI_TRANSFER_PASSWORD_LEN_MAX bytes.
Examples:
transfer_example.c.
open_error_t openapiTransferResultGet ( openapiClientHandle_t client_handle,
OPEN_TRANSFER_STATUS_t resultCode,
open_buffdesc resultStatus 
)

To retrieve the status of a transfer task in string format.

Parameters
[in]client_handleClient handle from registration API.
[out]resultCodeEnumerated value indicating the transfer download result
[out]resultStatusString value describing resultCode
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.
Note
The buffer for resultStatus should be at least OPENAPI_TRANSFER_RESULT_LEN_MAX bytes.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferServerAddressGet ( openapiClientHandle_t client_handle,
open_inet_addr_t inetAddr 
)

Get the transfer server address.

Parameters
[in]client_handleClient handle from registration API.
[out]inetAddrIPv4 or IPv6 address in network byte order of the server.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Examples:
transfer_example.c.
open_error_t openapiTransferServerAddressSet ( openapiClientHandle_t client_handle,
open_inet_addr_t  inetAddr 
)

Set the transfer server address.

Parameters
[in]client_handleClient handle from registration API.
[in]inetAddrIPv4 or IPv6 address in network byte order of the server.
Return values
OPEN_E_NONEif validation is successful.
OPEN_E_PARAMif parameters are not defined correctly.
OPEN_E_UNAVAILNot supported for this platform.

OpEN API Version: 1.10

Note
The inet address used for this API can come from the inetAddr value output by the openapiInetAddrFromIPAddrHostNameStr() API.
Examples:
transfer_example.c.