SDK Home Glossary Index Left Right Up

Network Interface


Section contents


Overview

Defined in

csocket.oxh


Construction / destruction


NewRNif - Constructor

Usage

this& = NewRNif&:

Description

Create a networking interface object and returns a handle to the created object.

Return value
this& A handle which represents the created network interface
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewRNif&:
  DeleteRNif:(this&) 

DeleteRNif - Destructor

Usage

DeleteRNif:(BYREF this&)

Description

Destroys the network interface object.

Arguments
BYREF this& A handle for a network interface object. A zero value is written back into the variable
Example
  LOCAL this&

  this& = NewRNif&:
  DeleteRNif:(this&) 

Methods provided


RNifAgentInfo - get agent information

Usage

err% = RNifAgentInfo%:(this&,info&)

Description

Get the agent information for the network interface connection

Arguments
this& A handle for a network interface object
info& A handle for a network interface agent information object
Return value
err% An error code

RNifCancelProgressNotification - cancel progress notification

Usage

RNifCancelProgressNotification:(this&)

Description

Cancel the notification of the network interface progress.

Arguments
this& A handle for a network interface object

RNifClose - close connection

Usage

RNifClose:(this&)

Description

Close the connection

Arguments
this& A handle for a network interface object

RNifDisableTimers - disable timers

Usage

err% = RNifDisableTimers%:(this&,disable%)

Description

Disable the timers

Arguments
this& A handle for a network interface object
disable% KTrue if the timers are to be disable, otherwise KFalse
Return value
err% An error code

RNifLastProgressError - last progress error

Usage

err% = RNifLastProgressError%:(this&,progress&)

Description

Get the progress of the network interface connection.

Arguments
this& A handle for a network interface object
progress& A handle for a network interface progress object
Return value
err% An error code

RNifNetworkActive - is the network active

Usage

err% = RNifNetworkActive%:(this&,BYREF active%)

Description

This routine returns true if the network interface is active.

Arguments
this& A handle for a network interface object
BYREF active% Set to KTrue% if the network is active, otherwise set to KFalse%
Return value
err% An error code

RNifOpen - open network interface

Usage

err% = RNifOpen%:(this&,name$,slots%)

Description

Opens the network interface connection.

Arguments
this& A handle for a network interface object
name$ Name of the network interface. Use "" for the default network interface
slots% The number of slots. Use KDefaultNifSlots% for the default number
Return value
err% An error code
Example
  LOCAL this&

  this& = NewRNif&:
  IF RNifOpen%:(this&,"",KDefaultNifSlots%) = 0
    RNifStop%:(this&)
    RNifClose:(this&)
  ENDIF
  DeleteRNif:(this&)

RNifProgress - progress of connection

Usage

err% = RNifProgress%:(this&,progress&)

Description

Get the progress status of the network connection.

Arguments
this& A handle for a network interface object
progress& A handle for a network interface progress object
Return value
err% An error code

RNifProgressNotificationA - progress notification

Usage

RNifProgressNotificationA:(this&,progress&,BYREF status&)

Description

Routine used to monitor when the progress status changes.

Arguments
this& A handle for a network interface object
progress& A handle for a network interface progress object
BYREF status& The status of the asynchronous operation

RNifStop - stop connection

Usage

err% = RNifStop%:(this&)

Description

Stop a network interface connection.

Arguments
this& A handle for a network interface object
Return value
err% An error code
Example
  LOCAL this&

  this& = NewRNif&:
  IF RNifOpen%:(this&,"",KDefaultNifSlots%) = 0
    RNifStop%:(this&)
    RNifClose:(this&)
  ENDIF
  DeleteRNif:(this&)

RNifVersion - get version number

Usage

version& = RNifVersion&:(this&)

Description

Returns a handle to a version object which should be deleted with DeleteVersion:() when it is no longer required.

Arguments
this& A handle for a network interface object
Return value
version& A handle to a version object

  SDK Home Glossary Index Left Right Up